We provide a Python SDK to interface programmatically with Ango Hub.
### SDK Documentation
The Documentation of imerit-ango is available in:
https://docs.imerit.net/sdk/sdk-documentation
--------------
For using API functionalities of Ango-Hub platform.
bash ./release.sh
## Local Development Guidelines
The actively used branch is `imerit`. To develop a new feature, branch out from the `imerit` branch and then open a pull request to `imerit`.
All the available `SDK` methods are under the `SDK` class in the `imerit_ango/sdk.py` file. To add a new method, simply create a new method inside the class definition.
### Conventions
Private methods are named with double underscore before their names (__). For example:
```python
def __calculate_something():
pass
```
### Running Tests Locally
For testing locally, create a file with a file name of your choice (lets say `test.py`). If the test file is at the root of the project, a sample code would look like this:
```python
from imerit_ango.sdk import SDK
sdk = SDK(api_key="YOUR_API_KEY", host="ANGO_HUB_SERVER_IP")
sdk.get_project("123456789")
```
"YOUR_API_KEY" can be obtained by [following the guide in the SDK docs](https://docs.imerit.net/sdk/sdk-documentation#obtaining-your-api-key).
"ANGO_HUB_SERVER_IP" is the address of the [Ango Hub server instance](https://github.com/imerit-io/angohub-server) you would like to use. If you need
to use the local version of the server, run the server locally and give the IP address of the local address of the
server (which is `http://127.0.0.1:3001` by default). You may also use `http://test.ango.ai` or `http://imerit.ango.ai` based on what you
need.
Raw data
{
"_id": null,
"home_page": null,
"name": "imerit-ango",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "imerit_ango, ango-hub, imerit_ango sdk, Ango, Ango-hub",
"author": "Faruk Karakaya",
"author_email": "<faruk@ango.ai>",
"download_url": null,
"platform": null,
"description": "\nWe provide a Python SDK to interface programmatically with Ango Hub.\n\n### SDK Documentation\n\nThe Documentation of imerit-ango is available in:\n\nhttps://docs.imerit.net/sdk/sdk-documentation\n\n--------------\nFor using API functionalities of Ango-Hub platform.\n \n bash ./release.sh\n\n\n## Local Development Guidelines\nThe actively used branch is `imerit`. To develop a new feature, branch out from the `imerit` branch and then open a pull request to `imerit`.\n\nAll the available `SDK` methods are under the `SDK` class in the `imerit_ango/sdk.py` file. To add a new method, simply create a new method inside the class definition.\n\n### Conventions\nPrivate methods are named with double underscore before their names (__). For example: \n\n```python\ndef __calculate_something():\n pass\n```\n\n### Running Tests Locally\nFor testing locally, create a file with a file name of your choice (lets say `test.py`). If the test file is at the root of the project, a sample code would look like this:\n\n```python\nfrom imerit_ango.sdk import SDK\n\nsdk = SDK(api_key=\"YOUR_API_KEY\", host=\"ANGO_HUB_SERVER_IP\")\n\nsdk.get_project(\"123456789\")\n\n```\n\n\n\"YOUR_API_KEY\" can be obtained by [following the guide in the SDK docs](https://docs.imerit.net/sdk/sdk-documentation#obtaining-your-api-key).\n\"ANGO_HUB_SERVER_IP\" is the address of the [Ango Hub server instance](https://github.com/imerit-io/angohub-server) you would like to use. If you need\nto use the local version of the server, run the server locally and give the IP address of the local address of the\nserver (which is `http://127.0.0.1:3001` by default). You may also use `http://test.ango.ai` or `http://imerit.ango.ai` based on what you\nneed.\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Ango-Hub SDK",
"version": "1.3.33",
"project_urls": null,
"split_keywords": [
"imerit_ango",
" ango-hub",
" imerit_ango sdk",
" ango",
" ango-hub"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f2d4c905f77c091de512e72d6452e55ec3fc685161305137f7632b08db47468",
"md5": "5fa239cf03a63a366501aa5ba68020fd",
"sha256": "b5fa5b9c013771af28fbcb80b98c47243f15abdc5524a6851cd257d1d0498964"
},
"downloads": -1,
"filename": "imerit_ango-1.3.33-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fa239cf03a63a366501aa5ba68020fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20046,
"upload_time": "2025-02-03T09:45:14",
"upload_time_iso_8601": "2025-02-03T09:45:14.748077Z",
"url": "https://files.pythonhosted.org/packages/3f/2d/4c905f77c091de512e72d6452e55ec3fc685161305137f7632b08db47468/imerit_ango-1.3.33-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-03 09:45:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "imerit-ango"
}
JSON