# Argus Enterprise API
[](https://github.com/budaesandrei/argus-enterprise-api/actions/workflows/ci_cd_pipeline.yml)
[](https://codecov.io/gh/budaesandrei/argus-enterprise-api)
[](https://pypi.python.org/pypi/argus-enterprise-api/)
[](LICENSE)
[](https://github.com/psf/black)
[]()
[]()
## Overview
This Python package is a convenient wrapper for interacting with the Argus API by [Altus Group](https://www.altusgroup.com/). The package dynamically generates Python classes and methods based on the API's Swagger specification, offering an intuitive way to interact with various Argus services like Workspace, ModelManagement, and more.
### Features
- Dynamically generated API methods
- Automatic API version handling
- Comprehensive documentation
- Easy-to-use Pythonic interfaces
## Installation
To install the package, run:
```
pip install argus-enterprise-api
```
## Quick Start
```python
from argus_enterprise_api import ArgusClient
# Initialize the client
client_key = "your_key"
client_secret = "your_secret"
cert_path = "your_cert_path"
cert_pwd = "your_cert_password"
email = "your_email_granted_to_argus_api"
env_id = "your_environment_id"
client = ArgusClient(
client_key=client_key,
client_secret=client_secret,
cert_path=cert_path,
cert_pwd=cert_pwd,
email=email,
env_id=env_id
)
# Use the Workspace API
workspace_instance = client.workspace
workspace_instance.some_method()
# Use the ModelManagement API
model_mgmt_instance = client.model_management
model_mgmt_instance.some_other_method()
```
## Documentation
Each dynamically generated class comes with comprehensive documentation. You can refer to the documentation for each class like so:
```python
print(ArgusClient.__doc__)
print(workspace_instance.some_method.__doc__)
print(model_mgmt_instance.some_method.__doc__)
```
For more technical details, refer to [Argus API Documentation](https://cloud.altusplatform.com/help/index.htm).
## Testing
To run the test suite:
```
pytest tests/
```
## Contributing
Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) for more information.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/budaesandrei/argus-enterprise-api",
"name": "argus-enterprise-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Andrei Budaes-Tanaru",
"author_email": "budaesandrei@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/62/b305adcdb62b4f179aa854e248f0c3f4ae76c76977126454c141c1b0de5f/argus-enterprise-api-1.0.7.tar.gz",
"platform": null,
"description": "# Argus Enterprise API\n\n[](https://github.com/budaesandrei/argus-enterprise-api/actions/workflows/ci_cd_pipeline.yml)\n[](https://codecov.io/gh/budaesandrei/argus-enterprise-api)\n[](https://pypi.python.org/pypi/argus-enterprise-api/)\n[](LICENSE)\n[](https://github.com/psf/black)\n[]()\n[]()\n\n## Overview\n\nThis Python package is a convenient wrapper for interacting with the Argus API by [Altus Group](https://www.altusgroup.com/). The package dynamically generates Python classes and methods based on the API's Swagger specification, offering an intuitive way to interact with various Argus services like Workspace, ModelManagement, and more.\n\n### Features\n\n- Dynamically generated API methods\n- Automatic API version handling\n- Comprehensive documentation\n- Easy-to-use Pythonic interfaces\n\n## Installation\n\nTo install the package, run:\n\n```\npip install argus-enterprise-api\n```\n\n## Quick Start\n\n```python\nfrom argus_enterprise_api import ArgusClient\n\n# Initialize the client\nclient_key = \"your_key\"\nclient_secret = \"your_secret\"\ncert_path = \"your_cert_path\"\ncert_pwd = \"your_cert_password\"\nemail = \"your_email_granted_to_argus_api\"\nenv_id = \"your_environment_id\"\n\nclient = ArgusClient(\n client_key=client_key,\n client_secret=client_secret,\n cert_path=cert_path,\n cert_pwd=cert_pwd,\n email=email,\n env_id=env_id\n)\n\n# Use the Workspace API\nworkspace_instance = client.workspace\nworkspace_instance.some_method()\n\n# Use the ModelManagement API\nmodel_mgmt_instance = client.model_management\nmodel_mgmt_instance.some_other_method()\n```\n\n## Documentation\n\nEach dynamically generated class comes with comprehensive documentation. You can refer to the documentation for each class like so:\n\n```python\nprint(ArgusClient.__doc__)\nprint(workspace_instance.some_method.__doc__)\nprint(model_mgmt_instance.some_method.__doc__)\n```\n\nFor more technical details, refer to [Argus API Documentation](https://cloud.altusplatform.com/help/index.htm).\n\n## Testing\n\nTo run the test suite:\n\n```\npytest tests/\n```\n\n## Contributing\n\nContributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) for more information.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python SDK for interacting with the Argus Enterprise API",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/budaesandrei/argus-enterprise-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8b3ce00d2af4a4625c7e09b0e6e9112d7c4d21fa6fb9c29bfd898c19d347319",
"md5": "54e8d61b7749bf6bccd8d29698d904e9",
"sha256": "0633305436b4fba1f3896e70c63d0f9097fd9c49e1834665b563d8bfa353a4ad"
},
"downloads": -1,
"filename": "argus_enterprise_api-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54e8d61b7749bf6bccd8d29698d904e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 482400,
"upload_time": "2023-10-06T18:41:59",
"upload_time_iso_8601": "2023-10-06T18:41:59.324995Z",
"url": "https://files.pythonhosted.org/packages/d8/b3/ce00d2af4a4625c7e09b0e6e9112d7c4d21fa6fb9c29bfd898c19d347319/argus_enterprise_api-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb62b305adcdb62b4f179aa854e248f0c3f4ae76c76977126454c141c1b0de5f",
"md5": "32cbe3984a73ad06057e30955fe41330",
"sha256": "4c2bf0a38c486013d4f8923c6630ac14fddb7a048a89ac813e5cc3df3db371e1"
},
"downloads": -1,
"filename": "argus-enterprise-api-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "32cbe3984a73ad06057e30955fe41330",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 473014,
"upload_time": "2023-10-06T18:42:01",
"upload_time_iso_8601": "2023-10-06T18:42:01.345010Z",
"url": "https://files.pythonhosted.org/packages/eb/62/b305adcdb62b4f179aa854e248f0c3f4ae76c76977126454c141c1b0de5f/argus-enterprise-api-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 18:42:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "budaesandrei",
"github_project": "argus-enterprise-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cryptography",
"specs": [
[
"<",
"42.0.0"
],
[
">=",
"41.0.0"
]
]
},
{
"name": "PyJWT",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"2.8.0"
]
]
},
{
"name": "requests",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"2.31.0"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"58.1.0"
],
[
"<",
"59.0.0"
]
]
},
{
"name": "validate-email-address",
"specs": [
[
"<",
"2.0"
],
[
">=",
"1.0"
]
]
}
],
"lcname": "argus-enterprise-api"
}
JSON
