Metadata-Version: 2.4
Name: dockflow_sdk
Version: 1.0.1
Summary: Dockflow v3 API
Home-page: https://github.com/Dockflow/dockflow-sdks
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/Dockflow/dockflow-sdks
Keywords: OpenAPI,OpenAPI-Generator,Dockflow v3 API
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page

# Dockflow API SDK for Python

The official Python client for the [Dockflow](https://dockflow.com) API v3: container and shipment tracking events,
tradeflows, documents and the tracking widget.

## Install

```sh
pip install dockflow-sdk
```

## Quickstart

Create an API key in the Dockflow console. Production is `https://api.dockflow.com`; test against the UAT sandbox at
`https://uat.dockflow.com` with a UAT key.

```python
import os
from dockflow_sdk import ApiClient, Configuration, UpstreamApi

config = Configuration(host="https://api.dockflow.com", access_token=os.environ["DOCKFLOW_KEY"])
with ApiClient(config) as client:
    page = UpstreamApi(client).get_upstream(tradeflow="PO4564268")
```

The four API classes are `UpstreamApi`, `TradeflowsApi`, `DocumentsApi` and `WidgetApi`.

## Documentation

- Guides and examples: https://docs.dockflow.com/api/sdk/
- OpenAPI 3.1 spec: https://api.dockflow.com/v3/openapi.json
- All five SDKs (TypeScript, Python, C#, Java, PHP): https://github.com/Dockflow/dockflow-sdks

## Versioning

Released automatically whenever the API changes. Versions follow semver: a breaking API change bumps the major
version, everything else the minor or patch.

## License

MIT
