No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs Additions to docs Aug 28, 2018
panoptes_client Allow editing collection descriptions Sep 2, 2018
.gitignore Initial commit Jun 10, 2016
.hound.yml Enable Python in .hound.yml Jul 14, 2016
.travis.yml
CHANGELOG.md
CONTRIBUTING.md Update CONTRIBUTING.md to recommend docker-compose May 26, 2017
Dockerfile.dev Add docs extras Oct 27, 2017
Dockerfile.dev2 Add docs extras Oct 27, 2017
Dockerfile.stable Build docker images from alpine Oct 25, 2017
Dockerfile.stable2 Build docker images from alpine Oct 25, 2017
LICENSE Initial commit Jun 10, 2016
README.md Additions to docs Aug 28, 2018
docker-compose.yml Enable debugging if PANOPTES_DEBUG is set in env Oct 13, 2017
setup.py Use multiple threads for media uploads Aug 7, 2018

README.md

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+git://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.