aind-codeocean-api
Python wrapper around CodeOcean's REST API.
DEPRECATION WARNING
Code Ocean has published their own SDK:
https://github.com/codeocean/codeocean-sdk-python
We will be dropping support of this package in favor of the official SDK.
Installation
To install from PyPI, run:
pip install aind-codeocean-api
To install from a clone of the repository, in the root directory, run
pip install -e .
To install the development libraries of the code, run
pip install -e .[dev]
Usage
Example of getting data asset metadata:
from aind_codeocean_api.codeocean import CodeOceanClient
domain = "https://acmecorp.codeocean.com"
token = "AN_API_TOKEN" # Replace with your api token
data_asset_id = "37a93748-ce90-4980-913b-2de0908d5212"
co_client = CodeOceanClient(domain=domain, token=token)
response = co_client.get_data_asset(data_asset_id=data_asset_id)
metadata = response.json()
To store credentials locally, run:
python -m aind_codeocean_api.credentials
Contributing
Linters and testing
There are several libraries used to run linters, check documentation, and run tests.
- Please test your changes using the coverage library, which will run the tests and log a coverage report:
coverage run -m unittest discover && coverage report
- Use interrogate to check that modules, methods, etc. have been documented thoroughly:
interrogate .
- Use flake8 to check that code is up to standards (no unused imports, etc.):
flake8 .
- Use black to automatically format the code into PEP standards:
black .
- Use isort to automatically sort import statements:
isort .
Pull requests
For internal members, please create a branch. For external members, please fork the repo and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:
<type>(<scope>): <short summary>
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- build: Changes that affect the build system or external dependencies (example scopes: pyproject.toml, setup.py)
- ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
Documentation
To generate the rst files source files for documentation, run
sphinx-apidoc -o doc_template/source/ src
Then to create the documentation html files, run
sphinx-build -b html doc_template/source/ doc_template/build/html
More info on sphinx installation can be found here: https://www.sphinx-doc.org/en/master/usage/installation.html
Metadata
Release files for aind-codeocean-api 0.5.2
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 | Actions |
|---|---|---|---|---|
| aind_codeocean_api-0.5.2.tar.gz | 49.5 kB | Without provenance | Details for aind_codeocean_api-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aind_codeocean_api-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for aind_codeocean_api-0.5.2-py3-none-any.whl |
Total release size: 63.3 kB
Release files / aind_codeocean_api-0.5.2.tar.gz
| Download URL | aind_codeocean_api-0.5.2.tar.gz |
|---|---|
| Size | 49.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0dfac2a5b0d7c42418b364c638c0004e6ce6a5a5a543194b1bceb461ecd077cf
|
|
BLAKE2b-256 checksum How to use checksums |
6843f191834deff3d0e2ac76a0e76f09c90caf9200a177e703f865df9573490d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / aind_codeocean_api-0.5.2-py3-none-any.whl
| Download URL | aind_codeocean_api-0.5.2-py3-none-any.whl |
|---|---|
| Size | 13.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
94db75ed98e00d8450f19c0de2931a52a135e44b67c7c96872f3f638f33e206b
|
|
BLAKE2b-256 checksum How to use checksums |
a5e45da60c53e1ea827c48086fef420f3cf75ee51abcf3f082cab006c7a70cff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for aind-codeocean-api 0.5.2
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.