Metadata-Version: 2.1
Name: lagoon-python-api
Version: 0.0.1
Summary: Lagoon python package
Home-page: https://docs.fatfish.app/dev/python/index.html
Author: Fatfish Lab
Author-email: lab@fatfi.sh
License: gpl-3.0
Project-URL: Documentation, https://docs.fatfish.app/dev/python/index.html
Project-URL: Source, https://github.com/fatfish-lab/lagoon-python-api
Project-URL: Lagoon, https://fatfi.sh/lagoon
Keywords: fatfish,lab,lagoon,studio,ressources,HR,software,licenses,talents,people,management,nodal,sdk,rest,cgi,vfx,video-game,api,python
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
Provides-Extra: dev


# 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 Studio](https://fatfi.sh/lagoon) users to interact with there data from directly from Python.

Lagoon Studio 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.

