<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, pip >= 20.3*
## Basic usage
```python
import alteia
sdk = alteia.SDK(user="YOUR_EMAIL_ADDRESS", password="YOUR_ALTEIA_PASSWORD")
projects = sdk.projects.search()
for project in projects:
print(project.name)
# My awesome project
```
<p> </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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/alteia-ai/alteia-python-sdk",
"name": "alteia",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.6.1",
"maintainer_email": null,
"keywords": "sdk, alteia",
"author": "Alteia Backend team",
"author_email": "backend-team@alteia.com",
"download_url": "https://files.pythonhosted.org/packages/21/40/f12fe79dd75f29e625cddb7fe60ead043dc15385e2b44d3b2ffb164add14/alteia-2.11.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"https://raw.githubusercontent.com/alteia-ai/alteia-python-sdk/master/docs/images/SDK_Python.png\" alt=\"logo\" style=\"max-width:100%;\">\n\n<p align=\"center\">\n<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>\n<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>\n</p>\n\n> This SDK offers a high-level Python interface to [Alteia APIs](https://www.alteia.com).\n\n## Installation\n\n```bash\npip install alteia\n```\n\n**requires Python >= 3.6.1, pip >= 20.3*\n\n## Basic usage\n\n```python\nimport alteia\n\nsdk = alteia.SDK(user=\"YOUR_EMAIL_ADDRESS\", password=\"YOUR_ALTEIA_PASSWORD\")\n\nprojects = sdk.projects.search()\n\nfor project in projects:\n print(project.name)\n\n# My awesome project\n```\n\n<p> </p>\n\n## \ud83d\udcd5 Documentation\n\n- [Reference documentation](https://alteia.readthedocs.io/en/latest/index.html)\n- [Jupyter notebook tutorials](https://github.com/alteia-ai/tutorials)\n\n## Contributing\n\nPackage installation:\n\n```bash\npoetry install\n```\n\n(Optional) To install pre-commit hooks (and detect problems before the pipelines):\n\n```bash\npip install pre-commit\npre-commit install\npre-commit run --all-files\npre-commit autoupdate # Optional, to update pre-commit versions\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "High-level Python interface to Alteia API",
"version": "2.11.0",
"project_urls": {
"Documentation": "https://alteia.readthedocs.io/en/latest/index.html",
"Homepage": "https://github.com/alteia-ai/alteia-python-sdk",
"Repository": "https://github.com/alteia-ai/alteia-python-sdk"
},
"split_keywords": [
"sdk",
" alteia"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9494d3e5f55b8f11acd6e8adeb339ab24bb428f0b9e59b0493707f7c7c343c6",
"md5": "9546d0ff5f4f7378321a0e9046f2413c",
"sha256": "7f997343f75351b4b438617b14c5102073b898080fd62790b31a7a4332c13574"
},
"downloads": -1,
"filename": "alteia-2.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9546d0ff5f4f7378321a0e9046f2413c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.6.1",
"size": 116137,
"upload_time": "2024-04-25T13:18:14",
"upload_time_iso_8601": "2024-04-25T13:18:14.523074Z",
"url": "https://files.pythonhosted.org/packages/d9/49/4d3e5f55b8f11acd6e8adeb339ab24bb428f0b9e59b0493707f7c7c343c6/alteia-2.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2140f12fe79dd75f29e625cddb7fe60ead043dc15385e2b44d3b2ffb164add14",
"md5": "a41659f98ec0caa42607e31fc9e2bb69",
"sha256": "cf22b2b77aa82ccc99507f0fd2b739e888e238b972239179135badb3df072bc9"
},
"downloads": -1,
"filename": "alteia-2.11.0.tar.gz",
"has_sig": false,
"md5_digest": "a41659f98ec0caa42607e31fc9e2bb69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.6.1",
"size": 73577,
"upload_time": "2024-04-25T13:18:16",
"upload_time_iso_8601": "2024-04-25T13:18:16.094752Z",
"url": "https://files.pythonhosted.org/packages/21/40/f12fe79dd75f29e625cddb7fe60ead043dc15385e2b44d3b2ffb164add14/alteia-2.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 13:18:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alteia-ai",
"github_project": "alteia-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "alteia"
}
JSON
