# teamdbapi
This module enables you to easily access the TeamDB Web API.
- Package version: 2.37.1
- TeamDB Web API version: 2.0
## Requirements.
- Python 3.4+
- TeamDB 2.37.1
## 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.assembly_select_current_assembly_with_http_info(assembly_id = "ddbb76fa-a4eb-4e70-81d8-de66c664ce20")
print(result)
# Get only response content
result = assembly_api.assembly_select_current_assembly(assembly_id = "ddbb76fa-a4eb-4e70-81d8-de66c664ce20")
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/1a/88/6d8fbdf4ca071d2d5595539a14bb040d1f0f641d4b26917b3f17f9fc3dfd/teamdbapi-2.37.1.tar.gz",
"platform": null,
"description": "# teamdbapi\nThis module enables you to easily access the TeamDB Web API.\n\n- Package version: 2.37.1\n- TeamDB Web API version: 2.0\n\n## Requirements.\n\n- Python 3.4+\n- TeamDB 2.37.1\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.assembly_select_current_assembly_with_http_info(assembly_id = \"ddbb76fa-a4eb-4e70-81d8-de66c664ce20\")\n print(result)\n\n # Get only response content\n result = assembly_api.assembly_select_current_assembly(assembly_id = \"ddbb76fa-a4eb-4e70-81d8-de66c664ce20\")\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": "2.37.1",
"project_urls": {
"Homepage": "https://www.tracksidesoftware.fr/teamdb"
},
"split_keywords": [
"teamdbapi",
"trackside",
"trackside software",
"teamdb"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1e14580399667c5a2d15d895b3500e096e3c2c5dbb0be4812e9aea5a9211152b",
"md5": "98ac6573b1f6adab1446761829951a8c",
"sha256": "89a3123b77904fd6a51d7344700b0adb68d54996579d1dbc6acc4f457cf9087d"
},
"downloads": -1,
"filename": "teamdbapi-2.37.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98ac6573b1f6adab1446761829951a8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 185653,
"upload_time": "2023-10-12T19:05:04",
"upload_time_iso_8601": "2023-10-12T19:05:04.631744Z",
"url": "https://files.pythonhosted.org/packages/1e/14/580399667c5a2d15d895b3500e096e3c2c5dbb0be4812e9aea5a9211152b/teamdbapi-2.37.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1a886d8fbdf4ca071d2d5595539a14bb040d1f0f641d4b26917b3f17f9fc3dfd",
"md5": "d030dfdfb83b9c48df78f8f440b0d146",
"sha256": "09456b58f793c7fbb1d1deda8155dd5dc24f2fae1c539cfce38c80c8335fdc24"
},
"downloads": -1,
"filename": "teamdbapi-2.37.1.tar.gz",
"has_sig": false,
"md5_digest": "d030dfdfb83b9c48df78f8f440b0d146",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 94018,
"upload_time": "2023-10-12T19:05:06",
"upload_time_iso_8601": "2023-10-12T19:05:06.860708Z",
"url": "https://files.pythonhosted.org/packages/1a/88/6d8fbdf4ca071d2d5595539a14bb040d1f0f641d4b26917b3f17f9fc3dfd/teamdbapi-2.37.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 19:05:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "teamdbapi"
}