teamdbapi
This module enables you to easily access the TeamDB Web API.
- Package version: 3.16.0
- TeamDB Web API version: 2.0
Requirements.
- Python 3.4+
- TeamDB 3.16.0
Installation and usage
pip install
Install via pip.
pip install teamdbapi
Then import the package:
import teamdbapi
Getting Started
Please follow the installation procedure above and then, depending your TeamDB WebApi configuration, try the following :
Using the HTTP protocole
import teamdbapi
from teamdbapi.rest import ApiException
# Create a Configuration object
configuration = teamdbapi.Configuration()
configuration.host = "http://localhost:9001" # Replace with your 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:
# Retrieve and print the current assembly before modification
result = assembly_api.get_current_assembly()
print(result)
# Set the desired current assembly, and print the response details
result = assembly_api.select_current_assembly_with_http_info(assembly_id = "6189993b-ad4d-4c41-8268-8419a63e5554") # Replace with your own valid Assembly id.
print(result)
# Retrieve and print the current assembly after modification
result = assembly_api.get_current_assembly()
print(result)
except ApiException as e:
print("Exception when selecting the current assembly : %s\n" % e)
Using the HTTPS protocole
import teamdbapi
from teamdbapi.rest import ApiException
# Create a Configuration object
configuration = teamdbapi.Configuration()
configuration.host = "https://localhost:9001" # Replace with your TeamDB API address if different
configuration.api_key['TDB_API_Key'] = 'user_token' # Replace {user_token} by a valid TeamDB WebApi user token.
# 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:
# Retrieve and print the current assembly before modification
result = assembly_api.get_current_assembly()
print(result)
# Set the desired current assembly, and print the response details
result = assembly_api.select_current_assembly_with_http_info(assembly_id = "6189993b-ad4d-4c41-8268-8419a63e5554") # Replace with your own valid Assembly id.
print(result)
# Retrieve and print the current assembly after modification
result = assembly_api.get_current_assembly()
print(result)
except ApiException as e:
print("Exception when selecting the current assembly : %s\n" % e)
NOTE: Each method has a detailed version (for example: select_current_assembly => select_current_assembly_with_http_info). This can be useful, for example, if you want to retrieve a detailed response: content, HTTP status code, HTTP header.
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
Trackside Software support@trackside.fr
Metadata
Release files for teamdbapi 3.16.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| teamdbapi-3.16.0.tar.gz | 150.3 kB | Without provenance | Details for teamdbapi-3.16.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| teamdbapi-3.16.0-py3-none-any.whl | Python 3 | none | any | Details for teamdbapi-3.16.0-py3-none-any.whl |
Total release size: 439.6 kB
Release files / teamdbapi-3.16.0.tar.gz
| Download URL | teamdbapi-3.16.0.tar.gz |
|---|---|
| Size | 150.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b219aec14d5d047bcf21419e6750c8d79df894d64c49ed4cd30a4dfe91d9a8a
|
|
BLAKE2b-256 checksum How to use checksums |
390397cd845c469368df7f393e34265aa537f9f36ca942d3fd06c1fcb578fbfc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Release files / teamdbapi-3.16.0-py3-none-any.whl
| Download URL | teamdbapi-3.16.0-py3-none-any.whl |
|---|---|
| Size | 289.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e64af636eefb3a25231db208f77a95e55fa707f6c22135ae5cb1da0043b0948e
|
|
BLAKE2b-256 checksum How to use checksums |
7c1ceaafb4d482fcec25cf526632f6df286508069331751486bc55d1f81693c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Security for teamdbapi 3.16.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.