fab-clientlib
Python client lib to access Flatland Association Benchmarks / AI4REALNET Campaign Hub Backend API, generated with openapi-generator
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.0
- Package version: v0.19.2
- Generator version: 7.15.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/flatland-association/flatland-benchmarks.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/flatland-association/flatland-benchmarks.git)
Then import the package:
import fab_clientlib
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import fab_clientlib
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import fab_clientlib
from fab_clientlib.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fab_clientlib.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with fab_clientlib.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = fab_clientlib.DefaultApi(api_client)
benchmark_ids = ['benchmark_ids_example'] # List[str] | Comma-separated list of IDs.
try:
api_response = api_instance.definitions_benchmarks_benchmark_ids_get(benchmark_ids)
print("The response of DefaultApi->definitions_benchmarks_benchmark_ids_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->definitions_benchmarks_benchmark_ids_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | definitions_benchmarks_benchmark_ids_get | GET /definitions/benchmarks/{benchmark_ids} | |
| DefaultApi | definitions_benchmarks_get | GET /definitions/benchmarks/ | |
| DefaultApi | definitions_fields_field_ids_get | GET /definitions/fields/{field_ids} | |
| DefaultApi | definitions_scenarios_scenario_ids_get | GET /definitions/scenarios/{scenario_ids} | |
| DefaultApi | definitions_suites_get | GET /definitions/suites | |
| DefaultApi | definitions_suites_suite_ids_get | GET /definitions/suites/{suite_ids} | |
| DefaultApi | definitions_tests_test_ids_get | GET /definitions/tests/{test_ids} | |
| DefaultApi | health_live_get | GET /health/live | |
| DefaultApi | info_get | GET /info | |
| DefaultApi | results_benchmarks_benchmark_id_tests_test_ids_get | GET /results/benchmarks/{benchmark_id}/tests/{test_ids} | |
| DefaultApi | results_benchmarks_benchmark_ids_get | GET /results/benchmarks/{benchmark_ids} | |
| DefaultApi | results_campaign_items_benchmark_ids_get | GET /results/campaign-items/{benchmark_ids} | |
| DefaultApi | results_campaigns_suite_ids_get | GET /results/campaigns/{suite_ids} | |
| DefaultApi | results_submissions_submission_id_scenarios_scenario_ids_get | GET /results/submissions/{submission_id}/scenarios/{scenario_ids} | |
| DefaultApi | results_submissions_submission_id_tests_test_ids_get | GET /results/submissions/{submission_id}/tests/{test_ids} | |
| DefaultApi | results_submissions_submission_id_tests_test_ids_post | POST /results/submissions/{submission_id}/tests/{test_ids} | |
| DefaultApi | results_submissions_submission_ids_get | GET /results/submissions/{submission_ids} | |
| DefaultApi | submissions_all_get | GET /submissions/all | |
| DefaultApi | submissions_get | GET /submissions | |
| DefaultApi | submissions_own_get | GET /submissions/own | |
| DefaultApi | submissions_post | POST /submissions | |
| DefaultApi | submissions_skip_enqueue_post | POST /submissions/skip_enqueue | |
| DefaultApi | submissions_submission_ids_get | GET /submissions/{submission_ids} | |
| DefaultApi | submissions_submission_ids_patch | PATCH /submissions/{submission_ids} | |
| DefaultApi | submissions_submission_ids_statuses_get | GET /submissions/{submission_ids}/statuses | |
| DefaultApi | submissions_submission_ids_statuses_post | POST /submissions/{submission_ids}/statuses |
Documentation For Models
- ApiResponse
- ApiResponseError
- DefinitionsBenchmarksGet200Response
- DefinitionsBenchmarksGet200ResponseAllOfBodyInner
- DefinitionsFieldsFieldIdsGet200Response
- DefinitionsFieldsFieldIdsGet200ResponseAllOfBodyInner
- DefinitionsScenariosScenarioIdsGet200Response
- DefinitionsScenariosScenarioIdsGet200ResponseAllOfBodyInner
- DefinitionsSuitesGet200Response
- DefinitionsSuitesGet200ResponseAllOfBodyInner
- DefinitionsTestsTestIdsGet200Response
- DefinitionsTestsTestIdsGet200ResponseAllOfBodyInner
- HealthLiveGet200Response
- HealthLiveGet200ResponseAllOfBody
- HealthLiveGet200ResponseAllOfBodyChecksInner
- InfoGet200Response
- InfoGet200ResponseAllOfBody
- ResultsBenchmarksBenchmarkIdTestsTestIdsGet200Response
- ResultsBenchmarksBenchmarkIdTestsTestIdsGet200ResponseAllOfBodyInner
- ResultsBenchmarksBenchmarkIdsGet200Response
- ResultsBenchmarksBenchmarkIdsGet200ResponseAllOfBodyInner
- ResultsCampaignItemsBenchmarkIdsGet200Response
- ResultsCampaignItemsBenchmarkIdsGet200ResponseAllOfBodyInner
- ResultsCampaignItemsBenchmarkIdsGet200ResponseAllOfBodyInnerItemsInner
- ResultsCampaignsSuiteIdsGet200Response
- ResultsCampaignsSuiteIdsGet200ResponseAllOfBodyInner
- ResultsCampaignsSuiteIdsGet200ResponseAllOfBodyInnerItemsInner
- ResultsSubmissionsSubmissionIdScenariosScenarioIdsGet200Response
- ResultsSubmissionsSubmissionIdTestsTestIdsGet200Response
- ResultsSubmissionsSubmissionIdTestsTestIdsPostRequest
- ResultsSubmissionsSubmissionIdTestsTestIdsPostRequestDataInner
- ResultsSubmissionsSubmissionIdsGet200Response
- ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInner
- ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInnerTestScoringsInner
- ResultsSubmissionsSubmissionIdsGet200ResponseAllOfBodyInnerTestScoringsInnerScenarioScoringsInner
- Scoring
- SubmissionsGet200Response
- SubmissionsGet200ResponseAllOfBodyInner
- SubmissionsPost200Response
- SubmissionsPost200ResponseAllOfBody
- SubmissionsPostRequest
- SubmissionsSubmissionIdsPatchRequest
- SubmissionsSubmissionIdsStatusesGet200Response
- SubmissionsSubmissionIdsStatusesGet200ResponseAllOfBodyInner
- SubmissionsSubmissionIdsStatusesPostRequest
Documentation For Authorization
Authentication schemes defined for the API:
oauth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://keycloak.flatland.cloud/realms/flatland/protocol/openid-connect/auth
- Scopes: N/A
Author
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fab_clientlib-0.19.2.tar.gz
(47.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fab_clientlib-0.19.2.tar.gz.
File metadata
- Download URL: fab_clientlib-0.19.2.tar.gz
- Upload date:
- Size: 47.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
10eee647c0096070694c7d6445578e367ad5d7481068af78f9c98f1233833997
|
|
| MD5 |
24a2f20b04c577022113409df08b4148
|
|
| BLAKE2b-256 |
e2758e6588af8599c9c7b0963a852f6bb2fc1a3c110f40e6b4bdccc9632fa648
|
File details
Details for the file fab_clientlib-0.19.2-py3-none-any.whl.
File metadata
- Download URL: fab_clientlib-0.19.2-py3-none-any.whl
- Upload date:
- Size: 113.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3327b609797cc31e7e5089ea8a06f339e1af65da9c1a197abd46115c153dcf16
|
|
| MD5 |
97683226906a2b12f8b1a11a6cc2b55d
|
|
| BLAKE2b-256 |
c118e745e7fb5b3e9573f2d4a583aa8aeabe925593deea5063a92b1e10baec56
|
