teamdbapi 3.10.1__tar.gz → 3.12.0__tar.gz

{teamdbapi-3.10.1 → teamdbapi-3.12.0}/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2025 Trackside Software
+Copyright © 2026 Trackside Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

teamdbapi-3.12.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: teamdbapi
+Version: 3.12.0
+Summary: Easily access the TeamDB Web API.
+Keywords: teamdbapi,Trackside,Trackside Software,TeamDB
+Author-email: Trackside Software <support@trackside.fr>
+Requires-Python: >=3.4
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+License-File: LICENSE
+Requires-Dist: certifi >= 14.05.14
+Requires-Dist: six >= 1.10
+Requires-Dist: python_dateutil >= 2.5.3
+Requires-Dist: setuptools >= 21.0.0
+Requires-Dist: urllib3 >= 1.15.1
+Project-URL: Home, https://www.tracksidesoftware.fr/teamdb
+
+# teamdbapi
+This module enables you to easily access the TeamDB Web API.
+
+- Package version: 3.12.0
+- TeamDB Web API version: 2.0
+
+## Requirements.
+
+- Python 3.4+
+- TeamDB 3.12.0
+
+## Installation and usage
+### pip install
+
+Install via  [pip](https://pypi.org/project/pip/).
+
+```sh
+pip install teamdbapi
+```
+
+Then import the package:
+```python
+import teamdbapi 
+```
+
+## Getting Started
+
+Please follow the installation procedure above and then, depending your TeamDB WebApi configuration, try the following :
+
+### Using the HTTP protocole
+
+```python
+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
+
+```python
+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
+
+

teamdbapi-3.12.0/README.md

@@ -0,0 +1,115 @@
+# teamdbapi
+This module enables you to easily access the TeamDB Web API.
+
+- Package version: 3.12.0
+- TeamDB Web API version: 2.0
+
+## Requirements.
+
+- Python 3.4+
+- TeamDB 3.12.0
+
+## Installation and usage
+### pip install
+
+Install via  [pip](https://pypi.org/project/pip/).
+
+```sh
+pip install teamdbapi
+```
+
+Then import the package:
+```python
+import teamdbapi 
+```
+
+## Getting Started
+
+Please follow the installation procedure above and then, depending your TeamDB WebApi configuration, try the following :
+
+### Using the HTTP protocole
+
+```python
+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
+
+```python
+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
+

{teamdbapi-3.10.1 → teamdbapi-3.12.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "teamdbapi"
-version = "3.10.1"
+version = "3.12.0"
 description = "Easily access the TeamDB Web API."
 authors = [{name = "Trackside Software", email = "support@trackside.fr"}]
 readme = "README.md"

{teamdbapi-3.10.1 → teamdbapi-3.12.0}/teamdbapi/api/assembly_api.py

@@ -120,7 +120,7 @@ class AssemblyApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/addrevisions', 'POST',
@@ -225,7 +225,7 @@ class AssemblyApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/addtag', 'POST',
@@ -318,7 +318,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/run/{runId}/assemblies', 'GET',
@@ -427,7 +427,7 @@ class AssemblyApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/compare', 'POST',
@@ -446,7 +446,7 @@ class AssemblyApi(object):
             collection_formats=collection_formats)
 
     def create_assembly(self, assembly, **kwargs):  # noqa: E501
-        """Create an assembly. The revisions list content will be ignored. You have to call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
+        """Create an assembly. The revisions list content will be ignored. You must call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
 
         Set Assembly.Id empty (00000000-0000-0000-0000-000000000000) in order to create a new assembly.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -468,7 +468,7 @@ class AssemblyApi(object):
             return data
 
     def create_assembly_with_http_info(self, assembly, **kwargs):  # noqa: E501
-        """Create an assembly. The revisions list content will be ignored. You have to call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
+        """Create an assembly. The revisions list content will be ignored. You must call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
 
         Set Assembly.Id empty (00000000-0000-0000-0000-000000000000) in order to create a new assembly.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -526,7 +526,7 @@ class AssemblyApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly', 'POST',
@@ -619,7 +619,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}', 'DELETE',
@@ -716,7 +716,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/duplicate', 'POST',
@@ -744,7 +744,7 @@ class AssemblyApi(object):
 
         :param async_req bool
         :param str assembly_id: The unique assembly id corresponding to the assembly to export. (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.m (required)
+        :param str output_file_path: The path to the file to create. You must provide the file extension for example : C:/path/MyFile.m (required)
         :return: bool
                  If the method is called asynchronously,
                  returns the request thread.
@@ -766,7 +766,7 @@ class AssemblyApi(object):
 
         :param async_req bool
         :param str assembly_id: The unique assembly id corresponding to the assembly to export. (required)
-        :param str output_file_path: The path to the file to create. You have to provide the file extension for example : C:/path/MyFile.m (required)
+        :param str output_file_path: The path to the file to create. You must provide the file extension for example : C:/path/MyFile.m (required)
         :return: bool
                  If the method is called asynchronously,
                  returns the request thread.
@@ -817,7 +817,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/export', 'POST',
@@ -910,7 +910,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/version/{versionId}/assemblies', 'GET',
@@ -1003,7 +1003,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}', 'GET',
@@ -1088,7 +1088,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/current', 'GET',
@@ -1181,7 +1181,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/grouprevisions', 'GET',
@@ -1282,7 +1282,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/group/{groupId}/revisions', 'GET',
@@ -1383,7 +1383,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/import', 'POST',
@@ -1484,7 +1484,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/run/{runId}/linkassembly', 'POST',
@@ -1585,7 +1585,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/lock', 'POST',
@@ -1690,7 +1690,7 @@ class AssemblyApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/removerevisions', 'POST',
@@ -1791,7 +1791,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}/removetag', 'POST',
@@ -1884,7 +1884,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/current', 'POST',
@@ -1985,7 +1985,7 @@ class AssemblyApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/run/{runId}/unlinkassembly', 'POST',
@@ -2004,7 +2004,7 @@ class AssemblyApi(object):
             collection_formats=collection_formats)
 
     def update_assembly(self, assembly_id, assembly, **kwargs):  # noqa: E501
-        """Update an assembly. The revisions list content will be ignored. You have to call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
+        """Update an assembly. The revisions list content will be ignored. You must call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -2026,7 +2026,7 @@ class AssemblyApi(object):
             return data
 
     def update_assembly_with_http_info(self, assembly_id, assembly, **kwargs):  # noqa: E501
-        """Update an assembly. The revisions list content will be ignored. You have to call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
+        """Update an assembly. The revisions list content will be ignored. You must call AddRevisionsToAssembly to add revisions to an assembly.  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -2090,7 +2090,7 @@ class AssemblyApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/assembly/{assemblyId}', 'PUT',

{teamdbapi-3.10.1 → teamdbapi-3.12.0}/teamdbapi/api/car_api.py

@@ -112,7 +112,7 @@ class CarApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/car', 'POST',
@@ -209,7 +209,7 @@ class CarApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/cartype', 'POST',
@@ -302,7 +302,7 @@ class CarApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/car/{carId}', 'DELETE',
@@ -395,7 +395,7 @@ class CarApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/cartype/{carTypeId}', 'DELETE',
@@ -488,7 +488,7 @@ class CarApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/car/{carId}', 'GET',
@@ -581,7 +581,7 @@ class CarApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/event/{eventId}/cars', 'GET',
@@ -666,7 +666,7 @@ class CarApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/cartypes', 'GET',
@@ -751,7 +751,7 @@ class CarApi(object):
             ['application/json', 'text/json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/car/current', 'GET',
@@ -856,7 +856,7 @@ class CarApi(object):
             ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])  # noqa: E501
 
         # Authentication setting
-        auth_settings = []  # noqa: E501
+        auth_settings = ['TdbApiKey']  # noqa: E501
 
         return self.api_client.call_api(
             '/teamdbapi/v2.0/car/{carId}', 'PUT',