catpy - Python client for the CATMAID API

Contents:

catpy

PyPI Package Version Continuous Integration Status Documentation Status License: MIT

Python client for the CATMAID API

Installation

Stable release

To install catpy, run this command in your terminal:

$ pip install catpy

This is the preferred method to install catpy, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for catpy can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/catmaid/catpy

Or download the tarball:

$ curl  -OL https://github.com/catmaid/catpy/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use catpy in a project:

import catpy

client = catpy.CatmaidClient(
    'https://YourCatmaidServer.org/catmaid',
    'Your CATMAID API token string')

query = {'object_ids': 42}
annotations = client.fetch('1/annotations/query', method='POST', data=query)

Instructions for getting your CATMAID API token string are available in the CATMAID documentation.

If the CATMAID server requires HTTP basic authentication, initialize the CatmaidClient with auth_name and auth_pass keyword arguments.

Contributing

Contributions are welcome. Before developing a feature or submitting a pull request, you may want to check the issue tracker to see if there is discussion about a similar idea.

Development

Here’s how to set up catpy for local development.

  1. Fork the catpy repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/catpy.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv catpy
$ cd catpy/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 catpy tests
$ python setup.py test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Credits

Creators

Contributors

See the git log, also available on GitHub.

Acknowledgements

catpy uses a packaging and build harness cookiecutter template.

History

0.1.0 (2017-05-12)

  • First release on PyPI.

Indices and tables