Skip to content

Commit 6d37dfd

Browse files
committed
Refactor kappy README
1 parent ed1db7a commit 6d37dfd

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

python/README.rst

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
Kappy
22
-----
33

4-
Do::
5-
>>> import kappy
6-
>>> client = kappy.KappaRest("http://url_of/the_server","project_name")
4+
Do
5+
6+
>>> import kappy
7+
>>> client = kappy.KappaRest("http\://url_of/the_server","project_name")
8+
79
to get a kappa client that uses the REST API hosted by
810
*http://url_of/the_server* and deals with project *project_name*.
911

10-
Do::
11-
>>> import kappy
12-
>>> client = kappy.KappaStd("KaSimAgent")
13-
to get a kappa client that uses a kappa agent installed locally. Replace
14-
*KaSimAgent* by *path/to/KaSimAgent* if the executable is not in your path.
12+
Do
13+
14+
>>> import kappy
15+
>>> client = kappy.KappaStd()
16+
17+
to get a kappa client that uses a kappa agent installed locally. Add a
18+
string argument specifing the *path/to/KaSimAgent* to use a specific agent.
1519

1620
A kappa agent can be obtained thanks to the *opam* package manager through::
21+
1722
$ opam install atdgen lwt
1823
$ opam pin add --dev KaSim
1924

20-
The methods of *client* can be infered by looking at **kappa_rest.py**
21-
file in the source distribution but have still to get documented properly...
25+
The methods of *client* is described in the **kappa_common.py**
26+
file in the source distribution.

0 commit comments

Comments
 (0)