lagoon-python-api


Namelagoon-python-api JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://docs.python.lagoon.fatfishlab.app
SummaryLagoon python package
upload_time2024-09-30 15:13:49
maintainerNone
docs_urlNone
authorFatfish Lab
requires_pythonNone
licensegpl-3.0
keywords fatfish lab lagoon studio ressources hr software licenses talents people management nodal sdk rest cgi vfx video-game api python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# Package python for Lagoon

![lagoon-python-api](https://github.com/fatfish-lab/lagoon-python-api/blob/main/docs/source/_static/logo.png?raw=true)

> Lagoon python API is a tool that allows [Lagoon](https://fatfi.sh/lagoon) users to interact with there data from directly from Python.

Lagoon is developed by [Fatfish Lab](https://fatfi.sh)

```python
# -*- coding: utf-8 -*-
from lagoon import Lagoon

lg = Lagoon('https://your-lagoon-server')
lg.connect(LG_USER, LG_PASSWORD)

organisations = lg.get_organisations()
hardware = organisations[0].get_hardware()
```

## Installation
This package is compatible with Python 2.7 and 3.7+

```python
python -m pip install lagoon-python-api
```
OR
```python
python -m pip install git+https://github.com/fatfish-lab/lagoon-python-api.git
```

## Documentation

Check our [documentation](https://docs.python.lagoon.fatfishlab.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 pylg`
   1. If needed, you can specify the version of python used in your virtual env : `virtualenv --python=/usr/bin/python3 pylg3`
1. Enable your virtual env : `source pylg/bin/activate`
1. Install local Lagoon package to your virtual env : `pip install -e /path/to/package/lagoon-python-api`

### Build the documation

1. `cd /path/to/package/lagoon-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.lagoon.fatfishlab.app",
    "name": "lagoon-python-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "fatfish, lab, lagoon, studio, ressources, HR, software, licenses, talents, people, management, nodal, sdk, rest, cgi, vfx, video-game, api, python",
    "author": "Fatfish Lab",
    "author_email": "lab@fatfi.sh",
    "download_url": "https://files.pythonhosted.org/packages/a7/62/bca5184167b3beba185998b8ee0cf372cae0f4f80615cdabcfcbea601177/lagoon-python-api-0.0.2.tar.gz",
    "platform": "any",
    "description": "\n# Package python for Lagoon\n\n![lagoon-python-api](https://github.com/fatfish-lab/lagoon-python-api/blob/main/docs/source/_static/logo.png?raw=true)\n\n> Lagoon python API is a tool that allows [Lagoon](https://fatfi.sh/lagoon) users to interact with there data from directly from Python.\n\nLagoon is developed by [Fatfish Lab](https://fatfi.sh)\n\n```python\n# -*- coding: utf-8 -*-\nfrom lagoon import Lagoon\n\nlg = Lagoon('https://your-lagoon-server')\nlg.connect(LG_USER, LG_PASSWORD)\n\norganisations = lg.get_organisations()\nhardware = organisations[0].get_hardware()\n```\n\n## Installation\nThis package is compatible with Python 2.7 and 3.7+\n\n```python\npython -m pip install lagoon-python-api\n```\nOR\n```python\npython -m pip install git+https://github.com/fatfish-lab/lagoon-python-api.git\n```\n\n## Documentation\n\nCheck our [documentation](https://docs.python.lagoon.fatfishlab.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 pylg`\n   1. If needed, you can specify the version of python used in your virtual env : `virtualenv --python=/usr/bin/python3 pylg3`\n1. Enable your virtual env : `source pylg/bin/activate`\n1. Install local Lagoon package to your virtual env : `pip install -e /path/to/package/lagoon-python-api`\n\n### Build the documation\n\n1. `cd /path/to/package/lagoon-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": "Lagoon python package",
    "version": "0.0.2",
    "project_urls": {
        "Documentation": "https://docs.python.lagoon.fatfishlab.app",
        "Homepage": "https://docs.python.lagoon.fatfishlab.app",
        "Lagoon": "https://fatfi.sh/lagoon",
        "Source": "https://github.com/fatfish-lab/lagoon-python-api"
    },
    "split_keywords": [
        "fatfish",
        " lab",
        " lagoon",
        " studio",
        " ressources",
        " hr",
        " software",
        " licenses",
        " talents",
        " people",
        " management",
        " nodal",
        " sdk",
        " rest",
        " cgi",
        " vfx",
        " video-game",
        " api",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "abd7a87db22e8ae98019e1a4c8ef6e6922c8b497537df10181ef2c9fd8d542e9",
                "md5": "1545b4058effb8d329329c4de78bceaa",
                "sha256": "8938ec885071c905e102db55715df96cab92da4f020d32532f548fc9a8d4963b"
            },
            "downloads": -1,
            "filename": "lagoon_python_api-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1545b4058effb8d329329c4de78bceaa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 30272,
            "upload_time": "2024-09-30T15:13:49",
            "upload_time_iso_8601": "2024-09-30T15:13:49.007678Z",
            "url": "https://files.pythonhosted.org/packages/ab/d7/a87db22e8ae98019e1a4c8ef6e6922c8b497537df10181ef2c9fd8d542e9/lagoon_python_api-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a762bca5184167b3beba185998b8ee0cf372cae0f4f80615cdabcfcbea601177",
                "md5": "701ccdbb8ec037a50236c526359aefad",
                "sha256": "27d714fda3d5b1d37a53857391b59e3ec9d7fb20eb9ca3f6dcb48a223a1e802a"
            },
            "downloads": -1,
            "filename": "lagoon-python-api-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "701ccdbb8ec037a50236c526359aefad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23507,
            "upload_time": "2024-09-30T15:13:49",
            "upload_time_iso_8601": "2024-09-30T15:13:49.989765Z",
            "url": "https://files.pythonhosted.org/packages/a7/62/bca5184167b3beba185998b8ee0cf372cae0f4f80615cdabcfcbea601177/lagoon-python-api-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-30 15:13:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fatfish-lab",
    "github_project": "lagoon-python-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lagoon-python-api"
}
Fatfish Lab
Elapsed time: 0.49361s