# teamdbapi
This module enables you to easily access the TeamDB Web API.
- Package version: 3.4.0
- TeamDB Web API version: 2.0
## Requirements.
- Python 3.4+
- TeamDB 3.4.0
## Installation and usage
### pip install
Install via [pip](http://pypi.python.org/pypi/pip).
```sh
pip install teamdbapi
```
Then import the package:
```python
import teamdbapi
```
## Getting Started
Please follow the [installation procedure](#Installation_and_usage_11) and then run the following:
```python
import teamdbapi
from teamdbapi.rest import ApiException
# Create a Configuration object
configuration = teamdbapi.Configuration()
configuration.host = "http://localhost:9001" # Replace with your the TeamDB API address if different
# Create an instance of the Client API
client_api = teamdbapi.ApiClient(configuration)
# Create an instance of the Assembly API using the client_api
assembly_api = teamdbapi.AssemblyApi(client_api)
# Try to execute the request
try:
# Get response with http info (Content, HTTP Status Code, HTTP Header)
result = assembly_api.select_current_assembly_with_http_info(assembly_id = "6189993b-ad4d-4c41-8268-8419a63e5554")
print(result)
# Get only response content
result = assembly_api.select_current_assembly(assembly_id = "6189993b-ad4d-4c41-8268-8419a63e5554")
print(result)
except ApiException as e:
print("Exception when selecting the current assembly : %s\n" % e)
```
## Documentation for API Endpoints
With a TeamDB Client, check the documentation at *http://localhost:9001* (Default value for the TeamDB Web API URL)
## Documentation For Authorization
Endpoints are subject to the same authorization as in TeamDB.
## Author
support@trackside.fr
Raw data
{
"_id": null,
"home_page": null,
"name": "teamdbapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "teamdbapi, Trackside, Trackside Software, TeamDB",
"author": null,
"author_email": "Trackside Software <support@trackside.fr>",
"download_url": "https://files.pythonhosted.org/packages/9d/02/e39655b09d5ecaddabfbb8ccba28f5c15c693714d2c60b08f48c8ece7b58/teamdbapi-3.4.0.tar.gz",
"platform": null,
"description": "# teamdbapi\nThis module enables you to easily access the TeamDB Web API.\n\n- Package version: 3.4.0\n- TeamDB Web API version: 2.0\n\n## Requirements.\n\n- Python 3.4+\n- TeamDB 3.4.0\n\n## Installation and usage\n### pip install\n\nInstall via [pip](http://pypi.python.org/pypi/pip).\n\n```sh\npip install teamdbapi\n```\n\nThen import the package:\n```python\nimport teamdbapi \n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#Installation_and_usage_11) and then run the following:\n\n```python\nimport teamdbapi\nfrom teamdbapi.rest import ApiException\n\n# Create a Configuration object\nconfiguration = teamdbapi.Configuration()\nconfiguration.host = \"http://localhost:9001\" # Replace with your the TeamDB API address if different\n\n# Create an instance of the Client API\nclient_api = teamdbapi.ApiClient(configuration)\n\n# Create an instance of the Assembly API using the client_api\nassembly_api = teamdbapi.AssemblyApi(client_api)\n\n# Try to execute the request\ntry:\n\n # Get response with http info (Content, HTTP Status Code, HTTP Header)\n result = assembly_api.select_current_assembly_with_http_info(assembly_id = \"6189993b-ad4d-4c41-8268-8419a63e5554\")\n print(result)\n\n # Get only response content\n result = assembly_api.select_current_assembly(assembly_id = \"6189993b-ad4d-4c41-8268-8419a63e5554\")\n print(result)\n\nexcept ApiException as e:\n print(\"Exception when selecting the current assembly : %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nWith a TeamDB Client, check the documentation at *http://localhost:9001* (Default value for the TeamDB Web API URL)\n\n## Documentation For Authorization\n\nEndpoints are subject to the same authorization as in TeamDB.\n\n## Author\n\nsupport@trackside.fr\n",
"bugtrack_url": null,
"license": null,
"summary": "Easily access the TeamDB Web API.",
"version": "3.4.0",
"project_urls": {
"Homepage": "https://www.tracksidesoftware.fr/teamdb"
},
"split_keywords": [
"teamdbapi",
" trackside",
" trackside software",
" teamdb"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "912b9362e77bd85beb4186cfc54a3474d7ebd1cdd1f14fe23f85c823277ed85a",
"md5": "e822da00f150962c2c60c90575a61f82",
"sha256": "6b68dc0e32177c55c8317895a0f49d168aea8d229b1fb8d92c5dc5db6200ba2a"
},
"downloads": -1,
"filename": "teamdbapi-3.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e822da00f150962c2c60c90575a61f82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 256382,
"upload_time": "2024-12-16T16:37:53",
"upload_time_iso_8601": "2024-12-16T16:37:53.887132Z",
"url": "https://files.pythonhosted.org/packages/91/2b/9362e77bd85beb4186cfc54a3474d7ebd1cdd1f14fe23f85c823277ed85a/teamdbapi-3.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9d02e39655b09d5ecaddabfbb8ccba28f5c15c693714d2c60b08f48c8ece7b58",
"md5": "be0d1157bc3b6ad9f857c863009cdea2",
"sha256": "d18a3165888fe0e0411ed67f27eac9f1332779b934c2f4ff2bff7c1a53f435bc"
},
"downloads": -1,
"filename": "teamdbapi-3.4.0.tar.gz",
"has_sig": false,
"md5_digest": "be0d1157bc3b6ad9f857c863009cdea2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 128918,
"upload_time": "2024-12-16T16:37:57",
"upload_time_iso_8601": "2024-12-16T16:37:57.012124Z",
"url": "https://files.pythonhosted.org/packages/9d/02/e39655b09d5ecaddabfbb8ccba28f5c15c693714d2c60b08f48c8ece7b58/teamdbapi-3.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 16:37:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "teamdbapi"
}
JSON