README.md

dlcs-api-client

A client library for accessing DLCS API

Usage

First, create a client:

from dlcs_api_client import Client

client = Client(base_url="https://api.example.com")

If the endpoints you're going to hit require authentication, use AuthenticatedClient instead:

from dlcs_api_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")

Now call your endpoint and use your models:

from dlcs_api_client import AuthenticatedClient, submit_batch
from dlcs_api_client.models import ImageHydraCollection

client = AuthenticatedClient(base_url="https://dlcs.digirati.io", token="xxx", prefix="Basic")
response = submit_batch(client=client, customer_id=1, json_body=ImageHydraCollection(
   members=[],
))

Building / publishing this package

This project uses Poetry to manage dependencies and packaging. Here are the basics:

1. Update the metadata in pyproject.toml (e.g. authors, version)
2. If you're using a private repository, configure it with Poetry
   1. poetry config repositories.<your-repository-name> <url-to-your-repository>
   2. poetry config http-basic.<your-repository-name> <username> <password>
3. Publish the client with poetry publish --build -r <your-repository-name> or, if for public PyPI, just poetry publish --build

If you want to install this client into another project without publishing it (e.g. for development) then:

1. If that project is using Poetry, you can simply do poetry add <path-to-this-client> from that project
2. If that project is not using Poetry:
   1. Build a wheel with poetry build -f wheel
   2. Install that wheel from the other project pip install <path-to-wheel>