# Package python for Aquarium
> Aquarium python API is a tool that allows [Aquarium](https://fatfi.sh/aquarium) users to interact with there data from directly from Python.
Aquarium 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.python.aquarium.app/) 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
1. 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`
1. Enable your virtual env : `source pyaq/bin/activate`
1. 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.python.aquarium.app",
"name": "aquarium-python-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "fatfish, lab, fatfishlab, 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/a9/48/5121f4c6ad81abdcec3d68c9daefdcb4242080d022c68a1389e818606239/aquarium_python_api-2.2.0.tar.gz",
"platform": "any",
"description": "\n# Package python for Aquarium\n\n\n\n> Aquarium python API is a tool that allows [Aquarium](https://fatfi.sh/aquarium) users to interact with there data from directly from Python.\n\nAquarium 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.python.aquarium.app/) 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\n1. 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`\n1. Enable your virtual env : `source pyaq/bin/activate`\n1. 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",
"bugtrack_url": null,
"license": "gpl-3.0",
"summary": "Aquarium python package",
"version": "2.2.0",
"project_urls": {
"Aquarium": "https://fatfi.sh/aquarium",
"Documentation": "https://docs.python.aquarium.app",
"Homepage": "https://docs.python.aquarium.app",
"Source": "https://github.com/fatfish-lab/aquarium-python-api"
},
"split_keywords": [
"fatfish",
" lab",
" fatfishlab",
" aquarium",
" studio",
" project",
" management",
" nodal",
" sdk",
" rest",
" cgi",
" vfx",
" api",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "18c3a1ca6012d7ec492aaaa3a273827310aab60ce14b607a867157b484c90d62",
"md5": "0dcba077bb43ffee3723b8ac1e83c1e9",
"sha256": "c6aa29e3276566c43c3e6e063847db3376c4a4ecaa4434f6ed80db8a651f1b73"
},
"downloads": -1,
"filename": "aquarium_python_api-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0dcba077bb43ffee3723b8ac1e83c1e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 48031,
"upload_time": "2025-09-03T15:32:37",
"upload_time_iso_8601": "2025-09-03T15:32:37.569535Z",
"url": "https://files.pythonhosted.org/packages/18/c3/a1ca6012d7ec492aaaa3a273827310aab60ce14b607a867157b484c90d62/aquarium_python_api-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a9485121f4c6ad81abdcec3d68c9daefdcb4242080d022c68a1389e818606239",
"md5": "e4b0938b939dc4a64424e5e510d3b9cd",
"sha256": "65fb2da133aebbbfb572f495c6980160a5c139ab15d748b0e7425d85b0c610c0"
},
"downloads": -1,
"filename": "aquarium_python_api-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e4b0938b939dc4a64424e5e510d3b9cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39937,
"upload_time": "2025-09-03T15:32:39",
"upload_time_iso_8601": "2025-09-03T15:32:39.034810Z",
"url": "https://files.pythonhosted.org/packages/a9/48/5121f4c6ad81abdcec3d68c9daefdcb4242080d022c68a1389e818606239/aquarium_python_api-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 15:32:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fatfish-lab",
"github_project": "aquarium-python-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aquarium-python-api"
}
JSON
