# Python client
API version: 0.2.2
## Requirements
- Python 3.10+
- Docker engine. [Documentation](https://docs.docker.com/engine/install/)
## Installation & Usage
1. If you don't have `Poetry` installed run:
```bash
pip install poetry
```
2. Install dependencies:
```bash
poetry config virtualenvs.in-project true
poetry install --no-root
```
3. Running tests:
```bash
poetry run pytest
```
You can test the application for multiple versions of Python. To do this, you need to install the required Python versions on your operating system, specify these versions in the tox.ini file, and then run the tests:
```bash
poetry run tox
```
Add the tox.ini file to `client/.openapi-generator-ignore` so that it doesn't get overwritten during client generation.
4. Building package:
```bash
poetry build
```
5. Publishing
```bash
poetry config pypi-token.pypi <pypi token>
poetry publish
```
## Client generator
To generate the client, execute the following script from the project root folder
```bash
poetry --directory server run python ./tools/client_generator/generate.py ./api/openapi.yaml
```
### Command
```bash
generate.py <file> [--asyncio]
```
#### Arguments
**file**
Specifies the input OpenAPI specification file path or URL. This argument is required for generating the Python client. The input file can be either a local file path or a URL pointing to the OpenAPI schema.
**--asyncio**
Flag to indicate whether to generate asynchronous code. If this flag is provided, the generated Python client will include asynchronous features. By default, synchronous code is generated.
#### Configuration
You can change the name of the client package in the file `/tools/client_generator/config.json`.
Add file's paths to `client/.openapi-generator-ignore` so that it doesn't get overwritten during client generation.
#### Examples
```bash
python generate.py https://<domain>/openapi.json
python generate.py https://<domain>/openapi.json --asyncio
python generate.py /<path>/openapi.yaml
python generate.py /<path>/openapi.yaml --asyncio
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import ds_search_service
from ds_search_service.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 = ds_search_service.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with ds_search_service.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ds_search_service.DecentralizedSearchApi(api_client)
request_body = None # Dict[str, object] |
try:
# Decentralized Search Across Catalogs
api_response = api_instance.distributed_search(request_body)
print("The response of DecentralizedSearchApi->distributed_search:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DecentralizedSearchApi->distributed_search: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DecentralizedSearchApi* | [**distributed_search**](docs/DecentralizedSearchApi.md#distributed_search) | **POST** /distributed-search/ | Decentralized Search Across Catalogs
*LocalSearchApi* | [**local_search**](docs/LocalSearchApi.md#local_search) | **POST** /local-search/ | Search Local Catalog
*DefaultApi* | [**health_check**](docs/DefaultApi.md#health_check) | **GET** /health-check | Health check
*DefaultApi* | [**metrics_metrics_get**](docs/DefaultApi.md#metrics_metrics_get) | **GET** /metrics | Metrics
## Documentation For Models
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HealthCheck](docs/HealthCheck.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
all-hiro@hiro-microdatacenters.nl
Raw data
{
"_id": null,
"home_page": null,
"name": "ds_search_service",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Data Space Search Service",
"author": "HIRO-MicroDataCenters",
"author_email": "all-hiro@hiro-microdatacenters.nl",
"download_url": "https://files.pythonhosted.org/packages/2c/91/f47ae18c9173e7edeab8529a66708070e91ae1e8494ca7df6e59d5773f2e/ds_search_service-0.2.2.tar.gz",
"platform": null,
"description": "# Python client\nAPI version: 0.2.2\n\n## Requirements\n\n- Python 3.10+\n- Docker engine. [Documentation](https://docs.docker.com/engine/install/)\n\n## Installation & Usage\n\n1. If you don't have `Poetry` installed run:\n\n```bash\npip install poetry\n```\n\n2. Install dependencies:\n\n```bash\npoetry config virtualenvs.in-project true\npoetry install --no-root\n```\n\n3. Running tests:\n\n```bash\npoetry run pytest\n```\n\nYou can test the application for multiple versions of Python. To do this, you need to install the required Python versions on your operating system, specify these versions in the tox.ini file, and then run the tests:\n```bash\npoetry run tox\n```\nAdd the tox.ini file to `client/.openapi-generator-ignore` so that it doesn't get overwritten during client generation.\n\n4. Building package:\n\n```bash\npoetry build\n```\n\n5. Publishing\n```bash\npoetry config pypi-token.pypi <pypi token>\npoetry publish\n```\n\n## Client generator\nTo generate the client, execute the following script from the project root folder\n```bash\npoetry --directory server run python ./tools/client_generator/generate.py ./api/openapi.yaml\n```\n\n### Command\n```bash\ngenerate.py <file> [--asyncio]\n```\n\n#### Arguments\n**file**\nSpecifies the input OpenAPI specification file path or URL. This argument is required for generating the Python client. The input file can be either a local file path or a URL pointing to the OpenAPI schema.\n\n**--asyncio**\nFlag to indicate whether to generate asynchronous code. If this flag is provided, the generated Python client will include asynchronous features. By default, synchronous code is generated.\n\n#### Configuration\nYou can change the name of the client package in the file `/tools/client_generator/config.json`.\n\nAdd file's paths to `client/.openapi-generator-ignore` so that it doesn't get overwritten during client generation.\n\n#### Examples\n\n```bash\npython generate.py https://<domain>/openapi.json\npython generate.py https://<domain>/openapi.json --asyncio\npython generate.py /<path>/openapi.yaml\npython generate.py /<path>/openapi.yaml --asyncio\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport ds_search_service\nfrom ds_search_service.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = ds_search_service.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith ds_search_service.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = ds_search_service.DecentralizedSearchApi(api_client)\n request_body = None # Dict[str, object] | \n\n try:\n # Decentralized Search Across Catalogs\n api_response = api_instance.distributed_search(request_body)\n print(\"The response of DecentralizedSearchApi->distributed_search:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DecentralizedSearchApi->distributed_search: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DecentralizedSearchApi* | [**distributed_search**](docs/DecentralizedSearchApi.md#distributed_search) | **POST** /distributed-search/ | Decentralized Search Across Catalogs\n*LocalSearchApi* | [**local_search**](docs/LocalSearchApi.md#local_search) | **POST** /local-search/ | Search Local Catalog\n*DefaultApi* | [**health_check**](docs/DefaultApi.md#health_check) | **GET** /health-check | Health check\n*DefaultApi* | [**metrics_metrics_get**](docs/DefaultApi.md#metrics_metrics_get) | **GET** /metrics | Metrics\n\n\n## Documentation For Models\n\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [HealthCheck](docs/HealthCheck.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\nall-hiro@hiro-microdatacenters.nl\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client for Data Space Search Service",
"version": "0.2.2",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" data space search service"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59a487954e42f62dcd244ada9e67a0fa3add84dcdc872150d474a9d179cb0733",
"md5": "bc9fa49676b9e0df71ee8c4ad2ce93d1",
"sha256": "65dfae43b1212fcff20acf3c670aa299a72631893952f513faf94560033f9dcb"
},
"downloads": -1,
"filename": "ds_search_service-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc9fa49676b9e0df71ee8c4ad2ce93d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 39600,
"upload_time": "2025-07-24T07:53:27",
"upload_time_iso_8601": "2025-07-24T07:53:27.567120Z",
"url": "https://files.pythonhosted.org/packages/59/a4/87954e42f62dcd244ada9e67a0fa3add84dcdc872150d474a9d179cb0733/ds_search_service-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c91f47ae18c9173e7edeab8529a66708070e91ae1e8494ca7df6e59d5773f2e",
"md5": "85e7b2b1160622877f569023554adf51",
"sha256": "67fa0f717e76b47122b864c76113386b65a28f0d528091c8c20b0ecf9f2ee34b"
},
"downloads": -1,
"filename": "ds_search_service-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "85e7b2b1160622877f569023554adf51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 24301,
"upload_time": "2025-07-24T07:53:28",
"upload_time_iso_8601": "2025-07-24T07:53:28.448049Z",
"url": "https://files.pythonhosted.org/packages/2c/91/f47ae18c9173e7edeab8529a66708070e91ae1e8494ca7df6e59d5773f2e/ds_search_service-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-24 07:53:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ds_search_service"
}
JSON