# Package python for Aquarium
![aquarium-python-api](https://github.com/fatfish-lab/aquarium-python-api/blob/main/docs/source/_static/logo.png?raw=true)
> Aquarium python API is a tool that allows [Aquarium Studio](https://fatfi.sh/aquarium) users to interact with there data from directly from Python.
Aquarium Studio is developed by [Fatfish Lab](https://fatfi.sh)
```python
# -*- coding: utf-8 -*-
from aquarium import Aquarium
aq = Aquarium('https://your-aquarium-server')
aq.connect(AQ_USER, AQ_PASSWORD)
me = aq.get_current_user()
my_tasks = me.get_tasks()
```
## Installation
This package is compatible with Python 2.7 and 3.7+
```python
python -m pip install aquarium-python-api
```
OR
```python
python -m pip install git+https://github.com/fatfish-lab/aquarium-python-api.git
```
## Documentation
Check our [documentation](https://docs.fatfish.app/dev/python/index.html) to find all the information you need.
## Maintainer
The repository is maintained by [Fatfish Lab](https://fatfi.sh)
## Support
You can contact our team at [support@fatfi.sh](mailto:support@fatfi.sh).
## Development
> Rather the package is compatible with python 2.7 and 3, the Sphinx documentation is using python 3.
1. Clone this repository
2. Setup a virtual env : `virtualenv pyaq`
3. Setup a virtual env : `virtualenv pyaq`
1. If needed, you can specify the version of python used in your virtual env : `virtualenv --python=/usr/bin/python3 pyaq3`
4. Enable your virtual env : `source pyaq/bin/activate`
5. Install local Aquarium package to your virtual env : `pip install -e /path/to/package/aquarium-python-api`
### Build the documation
1. `cd /path/to/package/aquarium-python-api/docs`
2. `make html`
## Licence
This project uses the following license: GPL-3.0-only.
See the license file to read it.
Raw data
{
"_id": null,
"home_page": "https://docs.fatfish.app/dev/python/index.html",
"name": "aquarium-python-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "fatfish,lab,aquarium,studio,project,management,nodal,sdk,rest,cgi,vfx,api,python",
"author": "Fatfish Lab",
"author_email": "lab@fatfi.sh",
"download_url": "https://files.pythonhosted.org/packages/ae/30/033aa1300344dd926ede54c027d150b4b96635bcdd259a3d71481c1808a9/aquarium-python-api-2.0.13.tar.gz",
"platform": "any",
"description": "\n# Package python for Aquarium\n\n![aquarium-python-api](https://github.com/fatfish-lab/aquarium-python-api/blob/main/docs/source/_static/logo.png?raw=true)\n\n> Aquarium python API is a tool that allows [Aquarium Studio](https://fatfi.sh/aquarium) users to interact with there data from directly from Python.\n\nAquarium Studio is developed by [Fatfish Lab](https://fatfi.sh)\n\n```python\n# -*- coding: utf-8 -*-\nfrom aquarium import Aquarium\n\naq = Aquarium('https://your-aquarium-server')\naq.connect(AQ_USER, AQ_PASSWORD)\n\nme = aq.get_current_user()\nmy_tasks = me.get_tasks()\n```\n\n## Installation\nThis package is compatible with Python 2.7 and 3.7+\n\n```python\npython -m pip install aquarium-python-api\n```\nOR\n```python\npython -m pip install git+https://github.com/fatfish-lab/aquarium-python-api.git\n```\n\n## Documentation\n\nCheck our [documentation](https://docs.fatfish.app/dev/python/index.html) to find all the information you need.\n\n## Maintainer\n\nThe repository is maintained by [Fatfish Lab](https://fatfi.sh)\n\n## Support\n\nYou can contact our team at [support@fatfi.sh](mailto:support@fatfi.sh).\n\n## Development\n\n> Rather the package is compatible with python 2.7 and 3, the Sphinx documentation is using python 3.\n\n1. Clone this repository\n2. Setup a virtual env : `virtualenv pyaq`\n3. Setup a virtual env : `virtualenv pyaq`\n 1. If needed, you can specify the version of python used in your virtual env : `virtualenv --python=/usr/bin/python3 pyaq3`\n4. Enable your virtual env : `source pyaq/bin/activate`\n5. Install local Aquarium package to your virtual env : `pip install -e /path/to/package/aquarium-python-api`\n\n### Build the documation\n\n1. `cd /path/to/package/aquarium-python-api/docs`\n2. `make html`\n\n## Licence\n\nThis project uses the following license: GPL-3.0-only.\nSee the license file to read it.\n\n\n\n",
"bugtrack_url": null,
"license": "gpl-3.0",
"summary": "Aquarium python package",
"version": "2.0.13",
"project_urls": {
"Aquarium": "https://fatfi.sh/aquarium",
"Documentation": "https://docs.fatfish.app/dev/python/index.html",
"Homepage": "https://docs.fatfish.app/dev/python/index.html",
"Source": "https://github.com/fatfish-lab/aquarium-python-api"
},
"split_keywords": [
"fatfish",
"lab",
"aquarium",
"studio",
"project",
"management",
"nodal",
"sdk",
"rest",
"cgi",
"vfx",
"api",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbb78a5c27621adb0d9025cce22dd3458f27e4a3b7305daef2cf101a9da17cc9",
"md5": "5d42322b75ec86acb10fdfa5f632ae64",
"sha256": "123dc6dbdeb185df6a4a349d898436e1bb5615c7a430b40ad3a8dce792a66955"
},
"downloads": -1,
"filename": "aquarium_python_api-2.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d42322b75ec86acb10fdfa5f632ae64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 45976,
"upload_time": "2024-03-14T15:08:50",
"upload_time_iso_8601": "2024-03-14T15:08:50.254180Z",
"url": "https://files.pythonhosted.org/packages/cb/b7/8a5c27621adb0d9025cce22dd3458f27e4a3b7305daef2cf101a9da17cc9/aquarium_python_api-2.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae30033aa1300344dd926ede54c027d150b4b96635bcdd259a3d71481c1808a9",
"md5": "c734cc34d213ee43a80734cdf393d6bc",
"sha256": "2b8b6844e0091541fbfed77f205916842e7f10fb67b4a35182f89ca8ea66f8c7"
},
"downloads": -1,
"filename": "aquarium-python-api-2.0.13.tar.gz",
"has_sig": false,
"md5_digest": "c734cc34d213ee43a80734cdf393d6bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34696,
"upload_time": "2024-03-14T15:08:52",
"upload_time_iso_8601": "2024-03-14T15:08:52.741322Z",
"url": "https://files.pythonhosted.org/packages/ae/30/033aa1300344dd926ede54c027d150b4b96635bcdd259a3d71481c1808a9/aquarium-python-api-2.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-14 15:08:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fatfish-lab",
"github_project": "aquarium-python-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "aquarium-python-api"
}