Metadata-Version: 2.0
Name: kappy
Version: 4.0.0.dev4
Summary: Wrapper to interact with the Kappa tool suite
Home-page: https://github.com/Kappa-Dev/KaSim.git
Author: Kappa-Dev
Author-email: kappa-dev@listes.sc.univ-paris-diderot.fr
License: LGPLv3
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Provides-Extra: REST
Requires-Dist: urllib3; extra == 'REST'

Kappy
-----

Do::
  >>> import kappy
  >>> client = kappy.KappaRest("http://url_of/the_server","project_name")
to get a kappa client that uses the REST API hosted by
*http://url_of/the_server* and deals with project *project_name*.

Do::
  >>> import kappy
  >>> client = kappy.KappaStd("KaSimAgent")
to get a kappa client that uses a kappa agent installed locally. Replace
*KaSimAgent* by *path/to/KaSimAgent* if the executable is not in your path.

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

The methods of *client* can be infered by looking at **kappa_rest.py**
file in the source distribution but have still to get documented properly...


