Metadata-Version: 2.1
Name: alteia
Version: 1.0.0
Summary: High-level Python interface to Alteia API
Home-page: https://github.com/alteia-ai/alteia-python-sdk
License: MIT
Keywords: sdk,alteia
Author: Alteia Backend team
Author-email: backend-team@alteia.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Build Tools
Provides-Extra: documentation
Requires-Dist: appdirs (>=1.4.3,<2.0.0)
Requires-Dist: pathvalidate (>=2.3.0,<3.0.0)
Requires-Dist: recommonmark (>=0.6.0,<0.7.0); extra == "documentation"
Requires-Dist: sphinx (>=3.2.1,<4.0.0); extra == "documentation"
Requires-Dist: sphinx-autobuild (>=2020.9.1,<2021.0.0); extra == "documentation"
Requires-Dist: sphinx_autodoc_typehints (>=1.11.0,<2.0.0); extra == "documentation"
Requires-Dist: urllib3 (>=1.23,<2.0)
Project-URL: Documentation, https://alteia.readthedocs.io/en/latest/index.html
Project-URL: Repository, https://github.com/alteia-ai/alteia-python-sdk
Description-Content-Type: text/markdown

<p align="center">
<img src="https://raw.githubusercontent.com/alteia-ai/alteia-python-sdk/master/docs/images/SDK_Python.png" alt="logo" style="max-width:100%;">

<p align="center">
<a href="https://pypi.org/project/alteia/" rel="nofollow"><img src="https://img.shields.io/pypi/v/alteia.svg" alt="pypi version" style="max-width:100%;"></a>
<a href="https://pypi.org/project/alteia/" rel="nofollow"><img src="https://img.shields.io/pypi/pyversions/alteia.svg" alt="compatible python versions" style="max-width:100%;"></a>
</p>

> This SDK offers a high-level Python interface to [Alteia APIs](https://www.alteia.com).

## Installation

```bash
pip install alteia
```

**requires Python >= 3.6.1*

## Basic usage

```python
import alteia

sdk = alteia.SDK(user="YOUR_EMAIL_ADDRESS", password="YOUR_ALTEIA_PASSWORD")

projects = sdk.projects.search(name="*")

for project in projects:
    print(project.name)

# My awesome project
```

<p>&nbsp;</p>

## 📕 Documentation

- [Reference documentation](https://alteia.readthedocs.io/en/latest/index.html)
- [Jupyter notebook tutorials](https://github.com/alteia-ai/tutorials)

## Contributing

Package installation:

```bash
poetry install
```

(Optional) To install pre-commit hooks (and detect problems before the pipelines):

```bash
pip install pre-commit
pre-commit install
pre-commit run --all-files
pre-commit autoupdate  # Optional, to update pre-commit versions
```

