ds_catalog 0.1.0

Client for Template web service

Python client

API version: 0.1.0

Requirements

• Python 3.10+
• Docker engine. Documentation

Installation & Usage

1. If you don't have Poetry installed run:

pip install poetry

2. Install dependencies:

poetry config virtualenvs.in-project true
poetry install --no-root

3. Running tests:

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:

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:

poetry build

5. Publishing

poetry config pypi-token.pypi <pypi token>
poetry publish

Client generator

To generate the client, execute the following script from the project root folder

poetry --directory server run python ./tools/client_generator/generate.py --file ./api/openapi.yaml

Command

generate.py [--file <a path or URL to a .yaml 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.

Saving Arguments

The script saves provided arguments for future use. Upon the initial execution, if no arguments are provided, the script will check if there are previously saved arguments in the specified file path. If saved arguments are found, they will be loaded and used for generating the client. If no saved arguments are found or if new arguments are provided, the script will save the provided arguments for future use.

This mechanism ensures that users can omit specifying arguments on subsequent executions if the same arguments were used previously. Saved arguments are stored in a JSON file located at generator/args.json.

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

python generate.py --file https://<domain>/openapi.json
python generate.py --file https://<domain>/openapi.json --asyncio
python generate.py --file /<path>/openapi.yaml
python generate.py --file /<path>/openapi.yaml --asyncio
python generate.py

Getting Started

Please follow the installation procedure and then run the following:

import ds_catalog
from ds_catalog.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_catalog.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with ds_catalog.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ds_catalog.DefaultApi(api_client)

    try:
        # Example endpoint
        api_response = api_instance.example_get()
        print("The response of DefaultApi->example_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->example_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	example_get	GET /	Example endpoint
DefaultApi	metrics_metrics_get	GET /metrics	Metrics
ItemsApi	items_create	POST /item/	Create an item
ItemsApi	items_delete_item	DELETE /item/{id}/	Delete an item
ItemsApi	items_read_all	GET /item/	Read all items
ItemsApi	items_read_item	GET /item/{id}/	Read an item
ItemsApi	items_update_item	PUT /item/{id}/	Update an item

Documentation For Models

• ExampleResponse
• HTTPValidationError
• Item
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Author

[e-mail]