Panoptes Client

This package is the Python SDK for Panoptes, the platform behind the Zooniverse. This module is intended to allow programmatic management of projects, providing high level access to the API for common project management tasks.

Full documentation is available at Read the Docs.

Installation

Install latest stable release:

$ pip install panoptes-client

Or for development or testing, you can install the development version directly from GitHub:

$ pip install -U git+https://github.com/zooniverse/panoptes-python-client.git

Upgrade an existing installation:

$ pip install -U panoptes-client

The Panoptes Client is supported on all versions of Python 2 and 3, from Python 2.7 onwards.

Usage Examples

Create a project:

from panoptes_client import Panoptes, Project

Panoptes.connect(username='example', password='example')

new_project = Project()
new_project.display_name = 'My new project'
new_project.description = 'A great new project!'
new_project.primary_language = 'en'
new_project.private = True
new_project.save()

See the documentation for additional examples.

Contributing

We welcome bug reports and code contributions. Please see CONTRIBUTING.md for information about how you can get involved.

Running the Tests

You can run the tests with Docker. This will run them under Python 3 and Python 2:

docker-compose build test && docker-compose run test
docker-compose build test2 && docker-compose run test2

Or you can run them directly in Python with:

python -m unittest discover

How does this help out? By making it easier for projects to be created and distributed with Zooniverse, it allows us to help with the development of Citizen Science. We can also investigate how to incorporate this into Stellarios (https://www.zooniverse.org/projects/droidology/stellarios)