# Fuel AI Python SDK
This Fuel AI Python SDK gives easy access to the Fuel AI Backend APIs.
## Installation
Install this package by using pip:
```bash
pip install --upgrade fuelai-python-sdk
```
### Requirements
* Python 3.6+
### Authentication
The library needs to be configured with your account's API KEY and API SECRET which is available in your Fuel AI Account - [https://fuelhq.ai/dashboard/apis](https://fuelhq.ai/dashboard/apis). Set `fuelai.api_key` and `fuelai.api_secret` to its value:
```python
import fuelai
fuelai.api_key = "YOUR API KEY"
fuelai.api_secret = "YOUR API SECRET"
```
Or set the API key as an environment variable:
```bash
export FUELAI_API_KEY=<YOUR API KEY>
export FUELAI_API_SECRET=<YOUR API SECRET>
```
### Projects
Once the API key has been set, you can use all the APIs
```python
# Create Project
new_project = fuelai.Project.create(name='NAME TO IDENTIFY',
orgProjectId='ID TO IDENTIFY (MAYBE SAME AS NAME)',
orgTemplateId='TEMPLATE ID - CONTACT FUEL AI TEAM FOR THIS')
print(new_project)
```
### Download Answers
Download Answers of the project. Please note that if out of 100 tasks, 40 are done, this API will download the 40 responses.
```python
# Download Answers
answers = fuelai.Answer.downloadAnswers(orgProjectId)
print(answers)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/FuelHQ-Public/fuelai-python",
"name": "fuelai-python-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Fuel AI",
"author_email": "technology@fuelhq.ai",
"download_url": "https://files.pythonhosted.org/packages/13/0e/d1b9f008aefdf22631c3fdfc828f68426b69bada55196a40ae86949a1e25/fuelai-python-sdk-1.0.3.tar.gz",
"platform": null,
"description": "# Fuel AI Python SDK\n\nThis Fuel AI Python SDK gives easy access to the Fuel AI Backend APIs.\n\n## Installation\n\nInstall this package by using pip:\n\n```bash\npip install --upgrade fuelai-python-sdk\n```\n\n### Requirements\n\n* Python 3.6+\n\n### Authentication\n\nThe library needs to be configured with your account's API KEY and API SECRET which is available in your Fuel AI Account - [https://fuelhq.ai/dashboard/apis](https://fuelhq.ai/dashboard/apis). Set `fuelai.api_key` and `fuelai.api_secret` to its value:\n\n```python\nimport fuelai\nfuelai.api_key = \"YOUR API KEY\"\nfuelai.api_secret = \"YOUR API SECRET\"\n```\nOr set the API key as an environment variable:\n\n```bash\nexport FUELAI_API_KEY=<YOUR API KEY>\nexport FUELAI_API_SECRET=<YOUR API SECRET>\n```\n\n### Projects\nOnce the API key has been set, you can use all the APIs\n\n```python\n# Create Project\nnew_project = fuelai.Project.create(name='NAME TO IDENTIFY',\n orgProjectId='ID TO IDENTIFY (MAYBE SAME AS NAME)',\n orgTemplateId='TEMPLATE ID - CONTACT FUEL AI TEAM FOR THIS')\n\nprint(new_project)\n```\n\n\n### Download Answers\nDownload Answers of the project. Please note that if out of 100 tasks, 40 are done, this API will download the 40 responses.\n\n```python\n# Download Answers\nanswers = fuelai.Answer.downloadAnswers(orgProjectId)\nprint(answers)\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fuel AI Python SDK",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/FuelHQ-Public/fuelai-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ae36376f2e6c8cb958eaa07cd0aef9f1e99013c776ff978f0acaa66b1d6f1f2",
"md5": "3232ffe3d3fe56e5dc31132bb1f42871",
"sha256": "94fc41cbfab1c5ee89a3ba4a3e1f2646925748493f6f926ad31604b15a04e35e"
},
"downloads": -1,
"filename": "fuelai_python_sdk-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3232ffe3d3fe56e5dc31132bb1f42871",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8284,
"upload_time": "2024-08-06T19:34:12",
"upload_time_iso_8601": "2024-08-06T19:34:12.326401Z",
"url": "https://files.pythonhosted.org/packages/3a/e3/6376f2e6c8cb958eaa07cd0aef9f1e99013c776ff978f0acaa66b1d6f1f2/fuelai_python_sdk-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "130ed1b9f008aefdf22631c3fdfc828f68426b69bada55196a40ae86949a1e25",
"md5": "8714ce629542abc4913a378f388adc0b",
"sha256": "96af0cfd733254552461caf6edeb5390120876e8c8108f64421e16f597170607"
},
"downloads": -1,
"filename": "fuelai-python-sdk-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "8714ce629542abc4913a378f388adc0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6073,
"upload_time": "2024-08-06T19:34:13",
"upload_time_iso_8601": "2024-08-06T19:34:13.473715Z",
"url": "https://files.pythonhosted.org/packages/13/0e/d1b9f008aefdf22631c3fdfc828f68426b69bada55196a40ae86949a1e25/fuelai-python-sdk-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 19:34:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FuelHQ-Public",
"github_project": "fuelai-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"~=",
"2.25"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"~=",
"2.8.1"
]
]
}
],
"lcname": "fuelai-python-sdk"
}
JSON
