pycaprio 0.3.1

Python client for the INCEpTION annotation tool remote API

PyCaprio

Python client for the INCEpTION annotation tool remote API.

Installation

At the moment, this fork of Pycaprio is only available here, in GitHub (see reasons in "Current state of Pycaprio" below):

python -m pip install git+https://github.com/inception-project/pycaprio.git@0.2.1#egg=pycaprio

Basic usage

The main object is the Pycaprio object, which will act as a client to interact with the API. You will need your INCEpTION's host and an user with a REMOTE role. Then, instantiate the Pycaprio client:

from pycaprio import Pycaprio

pycaprio_client = Pycaprio("http://inception-host.com", ('username', 'password'))

# Create a project
pycaprio_client.api.create_project("Project name", "creator-username")

Check the documentation if you want to know more.

Release

• Set the release version in pyproject.toml (e.g. version = "0.3.1")
• Create a tag for the version e.g. v0.3.1
• Push the tag - this will trigger a GitHub action that requires approval
• Approve the action (or ask somebody who has the necessary permissions to approve)
• Wait until build is complete and release is on pypi
• Set the next dev version in pyproject.toml (e.g. version = "0.4.0-dev")

License

PyCaprio is under the MIT license. Check it out here.

PyCaprio was originally developed by Savanamed and Javier Luna Molina. It is now part of the INCEpTION project.