# Agilix API
### By fr8train-sv
A Python SDK for integrating with Agilix Buzz API. Install with:
```bash
pip install agilix-api-fr8train
```
Upgrade this specific library by running:
```bash
pip install --upgrade agilix-api-fr8train
```
## Important Commands
The following list of commands are important for project maintenance.
## Building the Library
To build the library, ensure that the necessary build tools are installed in your environment. This can be done by installing `setuptools`, `build`, and `wheel`:
```bash
pip install build twine setuptools wheel
```
`twine` can also be installed here while we're installing shit since we'll need it later.
**REMEMBER**: INCREMENT YOUR VERSION NUMBER IN THE TOML BEFORE BUILDING.
**REMEMBER**: REMOVE THE /DIST DIRECTORY BEFORE BUILDING FOR A CLEAN BUILD
Now, you can create the distribution files (source distribution and wheel) using the following command:
```bash
python3 -m build
```
This will generate builds in the `dist/` directory.
## Deploying to PyPI
Ensure you have a valid PyPI account and credentials added to your `.pypirc` file or provide them during the publish process. Then, upload your package to PyPI with:
```bash
python3 -m twine upload dist/*
```
Follow any prompts from `twine` to successfully upload your package. Once deployed, your package will be available on PyPI.
# Usage
## Initialization
To start using the API SDK, you will need to initialize an API object:
```python
from agilix_api_fr8train.api import Api
api = Api()
```
This will reach out into your project for a .env file for credentials to establish a connection to the Agilix API Gateway.
Structure your .env file like the example below and maintain it at the root of your project directory.
```dotenv
BASE_URL=
DOMAIN=
USERNAME=
PASSWORD=
HOME_DOMAIN_ID=
```
Raw data
{
"_id": null,
"home_page": null,
"name": "agilix-api-fr8train",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "agilix, api, sdk, buzz, integration",
"author": null,
"author_email": "Tyler Collette <tyler.collette@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bb/e0/1dcc21b4b443017fb693c052420332418f3dd114239ff6b79d0d1a21a71e/agilix_api_fr8train-1.1.2.tar.gz",
"platform": null,
"description": "# Agilix API\n### By fr8train-sv\n\nA Python SDK for integrating with Agilix Buzz API. Install with:\n\n```bash\n pip install agilix-api-fr8train\n```\n\nUpgrade this specific library by running:\n\n```bash\n pip install --upgrade agilix-api-fr8train\n```\n\n## Important Commands\n\nThe following list of commands are important for project maintenance.\n\n## Building the Library\n\nTo build the library, ensure that the necessary build tools are installed in your environment. This can be done by installing `setuptools`, `build`, and `wheel`:\n\n```bash\n pip install build twine setuptools wheel\n```\n\n`twine` can also be installed here while we're installing shit since we'll need it later. \n\n**REMEMBER**: INCREMENT YOUR VERSION NUMBER IN THE TOML BEFORE BUILDING. \n\n**REMEMBER**: REMOVE THE /DIST DIRECTORY BEFORE BUILDING FOR A CLEAN BUILD\n\nNow, you can create the distribution files (source distribution and wheel) using the following command:\n\n```bash\n python3 -m build\n```\n\nThis will generate builds in the `dist/` directory.\n\n## Deploying to PyPI\n\nEnsure you have a valid PyPI account and credentials added to your `.pypirc` file or provide them during the publish process. Then, upload your package to PyPI with:\n\n```bash\n python3 -m twine upload dist/*\n```\n\nFollow any prompts from `twine` to successfully upload your package. Once deployed, your package will be available on PyPI. \n\n# Usage\n\n## Initialization\n\nTo start using the API SDK, you will need to initialize an API object:\n\n```python\nfrom agilix_api_fr8train.api import Api\n\napi = Api()\n```\n\nThis will reach out into your project for a .env file for credentials to establish a connection to the Agilix API Gateway.\nStructure your .env file like the example below and maintain it at the root of your project directory.\n\n```dotenv\nBASE_URL=\nDOMAIN=\nUSERNAME=\nPASSWORD=\nHOME_DOMAIN_ID=\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python SDK for integrating with the Agilix Buzz API",
"version": "1.1.2",
"project_urls": {
"Changelog": "https://github.com/fr8train-sv/agilix-api/releases",
"Documentation": "https://github.com/fr8train-sv/agilix-api/wiki",
"Source": "https://github.com/fr8train-sv/agilix-api"
},
"split_keywords": [
"agilix",
" api",
" sdk",
" buzz",
" integration"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eea53e24efbd29774124b1ad38aa7301f8a6de4edc680ab9bd35fdeea4c66ac2",
"md5": "0930d94f40443f06755a883d0f63c68f",
"sha256": "6e8e66d8079e4c27280bce92731d966d08bd04bb544c8f45446f8d9eaad8814d"
},
"downloads": -1,
"filename": "agilix_api_fr8train-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0930d94f40443f06755a883d0f63c68f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16642,
"upload_time": "2025-09-05T12:34:49",
"upload_time_iso_8601": "2025-09-05T12:34:49.297630Z",
"url": "https://files.pythonhosted.org/packages/ee/a5/3e24efbd29774124b1ad38aa7301f8a6de4edc680ab9bd35fdeea4c66ac2/agilix_api_fr8train-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bbe01dcc21b4b443017fb693c052420332418f3dd114239ff6b79d0d1a21a71e",
"md5": "a064982d592c9180d153ada282bc434f",
"sha256": "1b397ce3139a86573c11ab7053f01d5fde819de6e0c647e8c93391bf1eef7e04"
},
"downloads": -1,
"filename": "agilix_api_fr8train-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a064982d592c9180d153ada282bc434f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12653,
"upload_time": "2025-09-05T12:34:50",
"upload_time_iso_8601": "2025-09-05T12:34:50.197569Z",
"url": "https://files.pythonhosted.org/packages/bb/e0/1dcc21b4b443017fb693c052420332418f3dd114239ff6b79d0d1a21a71e/agilix_api_fr8train-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 12:34:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fr8train-sv",
"github_project": "agilix-api",
"github_not_found": true,
"lcname": "agilix-api-fr8train"
}
JSON
