Skip to main content

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.

Project description

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 tests && docker-compose run tests
docker-compose build tests2 && docker-compose run tests2

Or you can run them directly in Python with:

python -m unittest discover

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panoptes_client-1.6.1.tar.gz (36.5 kB view hashes)

Uploaded Source

Built Distribution

panoptes_client-1.6.1-py3-none-any.whl (46.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page