aquarium-python-api


Nameaquarium-python-api JSON
Version 2.1.0 PyPI version JSON
download
home_pagehttps://docs.fatfish.app/dev/python/index.html
SummaryAquarium python package
upload_time2024-05-06 08:32:49
maintainerNone
docs_urlNone
authorFatfish Lab
requires_pythonNone
licensegpl-3.0
keywords fatfish lab aquarium studio project management nodal sdk rest cgi vfx api python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# 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
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.fatfish.app/dev/python/index.html",
    "name": "aquarium-python-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "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/f5/17/1abb988cdf21d03f1cff7ffadd41370bf995e75efc860b7a66c8bf839f9c/aquarium-python-api-2.1.0.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\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\n\n",
    "bugtrack_url": null,
    "license": "gpl-3.0",
    "summary": "Aquarium python package",
    "version": "2.1.0",
    "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": "187b97d26d52251e259e2c0ea48955d2ebdc0c3cdb33163b51faec23717b43d9",
                "md5": "9b3602b7455e17c236fe5bb8e2766458",
                "sha256": "e05dfe875b5d8939b1f4b23853c765d7fc4d7910f1a44ba23467b63691b122b7"
            },
            "downloads": -1,
            "filename": "aquarium_python_api-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9b3602b7455e17c236fe5bb8e2766458",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 47003,
            "upload_time": "2024-05-06T08:32:47",
            "upload_time_iso_8601": "2024-05-06T08:32:47.352583Z",
            "url": "https://files.pythonhosted.org/packages/18/7b/97d26d52251e259e2c0ea48955d2ebdc0c3cdb33163b51faec23717b43d9/aquarium_python_api-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f5171abb988cdf21d03f1cff7ffadd41370bf995e75efc860b7a66c8bf839f9c",
                "md5": "7741bb4d0f6ee8ef7b34afba0b715b97",
                "sha256": "abe18e26ed9b5e01473f3ba5ea616c09c8f1e3e35c30215a1481a8571beb2363"
            },
            "downloads": -1,
            "filename": "aquarium-python-api-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7741bb4d0f6ee8ef7b34afba0b715b97",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 39175,
            "upload_time": "2024-05-06T08:32:49",
            "upload_time_iso_8601": "2024-05-06T08:32:49.098004Z",
            "url": "https://files.pythonhosted.org/packages/f5/17/1abb988cdf21d03f1cff7ffadd41370bf995e75efc860b7a66c8bf839f9c/aquarium-python-api-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-06 08:32:49",
    "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"
}
Fatfish Lab
Elapsed time: 0.25370s