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
4 maintainers
Metadata
4 maintainers
Release files for panoptes-client 1.7.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| panoptes_client-1.7.1.tar.gz | 38.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| panoptes_client-1.7.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 88.5 kB
Release files / panoptes_client-1.7.1.tar.gz
| Download URL | panoptes_client-1.7.1.tar.gz |
|---|---|
| Size | 38.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
325b67673c5bfa63651db00b62c3c9c0a617b6a44a55a453151082d96fe27b2b
|
|
BLAKE2b-256 checksum How to use checksums |
039ff664bcafbec8e430547025f90927e1cfd519cdd19fa4c02ccd64594fca53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / panoptes_client-1.7.1-py3-none-any.whl
| Download URL | panoptes_client-1.7.1-py3-none-any.whl |
|---|---|
| Size | 49.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
11ccd9e5f0c19897636c70d437165d32fa4d79f399f8c2b009599d86babb104d
|
|
BLAKE2b-256 checksum How to use checksums |
c3722c6d9e0049abb197d2a5d7d3f917542fe14d8b63fa4faea5508fbae25152
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Security for panoptes-client 1.7.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
