# aind-codeocean-api
[](LICENSE)
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](https://pypi.org/project/aind-codeocean-api/), 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](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) 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
Raw data
{
"_id": null,
"home_page": null,
"name": "aind-codeocean-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Allen Institute for Neural Dynamics",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/97/b4/55b3b3de22751fa13fcae41480b6da295236f8870da27752ccf6ced25d73/aind_codeocean_api-0.5.1.tar.gz",
"platform": null,
"description": "# aind-codeocean-api\n\n[](LICENSE)\n\n\nPython wrapper around CodeOcean's REST API.\n\n# DEPRECATION WARNING\n\nCode Ocean has published their own SDK:\n\nhttps://github.com/codeocean/codeocean-sdk-python\n\nWe will be dropping support of this package in favor of the official SDK.\n\n## Installation\nTo install from [PyPI](https://pypi.org/project/aind-codeocean-api/), run:\n```\npip install aind-codeocean-api\n```\n\nTo install from a clone of the repository, in the root directory, run\n```\npip install -e .\n```\n\nTo install the development libraries of the code, run\n```\npip install -e .[dev]\n```\n\n## Usage\nExample of getting data asset metadata:\n```\nfrom aind_codeocean_api.codeocean import CodeOceanClient\n\ndomain = \"https://acmecorp.codeocean.com\"\ntoken = \"AN_API_TOKEN\" # Replace with your api token\ndata_asset_id = \"37a93748-ce90-4980-913b-2de0908d5212\"\nco_client = CodeOceanClient(domain=domain, token=token)\nresponse = co_client.get_data_asset(data_asset_id=data_asset_id)\nmetadata = response.json()\n```\n\nTo store credentials locally, run:\n```\npython -m aind_codeocean_api.credentials\n```\n\n## Contributing\n\n### Linters and testing\n\nThere are several libraries used to run linters, check documentation, and run tests.\n\n- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:\n\n```\ncoverage run -m unittest discover && coverage report\n```\n\n- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:\n\n```\ninterrogate .\n```\n\n- Use **flake8** to check that code is up to standards (no unused imports, etc.):\n```\nflake8 .\n```\n\n- Use **black** to automatically format the code into PEP standards:\n```\nblack .\n```\n\n- Use **isort** to automatically sort import statements:\n```\nisort .\n```\n\n### Pull requests\n\nFor 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](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:\n```\n<type>(<scope>): <short summary>\n```\n\nwhere scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:\n\n- **build**: Changes that affect the build system or external dependencies (example scopes: pyproject.toml, setup.py)\n- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)\n- **docs**: Documentation only changes\n- **feat**: A new feature\n- **fix**: A bug fix\n- **perf**: A code change that improves performance\n- **refactor**: A code change that neither fixes a bug nor adds a feature\n- **test**: Adding missing tests or correcting existing tests\n\n### Documentation\nTo generate the rst files source files for documentation, run\n```\nsphinx-apidoc -o doc_template/source/ src \n```\nThen to create the documentation html files, run\n```\nsphinx-build -b html doc_template/source/ doc_template/build/html\n```\nMore info on sphinx installation can be found here: https://www.sphinx-doc.org/en/master/usage/installation.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CodeOcean API manager in Python",
"version": "0.5.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a5f4befda96da3f9232f3fc5f5829960e7494b9e2a77326f379a1bb6357899e",
"md5": "3f49ad3a19326be9b68fa2e63a24cd6e",
"sha256": "790d09003586b68a086b90a9962dd0471d7666842f65b5e4864048faf95ef31b"
},
"downloads": -1,
"filename": "aind_codeocean_api-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f49ad3a19326be9b68fa2e63a24cd6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13855,
"upload_time": "2024-11-05T01:22:14",
"upload_time_iso_8601": "2024-11-05T01:22:14.338097Z",
"url": "https://files.pythonhosted.org/packages/7a/5f/4befda96da3f9232f3fc5f5829960e7494b9e2a77326f379a1bb6357899e/aind_codeocean_api-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97b455b3b3de22751fa13fcae41480b6da295236f8870da27752ccf6ced25d73",
"md5": "10ecd2861a5f5788e24482d90ff7b9db",
"sha256": "416c5a648b5d689cd4a7b108263ddf775430c5b5afb5d281ea0ff5ad0a3fdea6"
},
"downloads": -1,
"filename": "aind_codeocean_api-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "10ecd2861a5f5788e24482d90ff7b9db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 49392,
"upload_time": "2024-11-05T01:22:15",
"upload_time_iso_8601": "2024-11-05T01:22:15.467236Z",
"url": "https://files.pythonhosted.org/packages/97/b4/55b3b3de22751fa13fcae41480b6da295236f8870da27752ccf6ced25d73/aind_codeocean_api-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 01:22:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aind-codeocean-api"
}
JSON