Metadata-Version: 2.4
Name: owasp-dependency-track-client
Version: 4.13.2
Summary: Inofficial OWASP Dependency Track API Python client
Home-page: https://github.com/mreiche/owasp-dependency-track-python-client
Author: Mike Reiche
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs>=22.1.0
Requires-Dist: httpx>=0.23.0
Requires-Dist: python-dateutil>=2.8.2
Dynamic: author
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# OWASP Dependency Track Python API client

This is a generated library based on the official OWASP Dependency Track OpenAPI spec (`/api/openapi.json`) using [openapi-python-client](https://github.com/openapi-generators/openapi-python-client).

## Usage

```shell
pip install owasp-dependency-track-client
```

Create the client
```python
from owasp_dt import Client

client = Client(
    base_url="http://localhost:8081/api",
    headers={
        "X-Api-Key": "YOUR API KEY"
    },
    verify_ssl=False,
)
```

Call endpoints:
```python
from owasp_dt.api.project import get_projects

projects = get_projects.sync(client=client)
assert len(projects) > 0
```

## CLI

If you're looking for a CLI tool: [owasp-dependency-track-cli](https://github.com/mreiche/owasp-dependency-track-cli)

## Update the library

1. Install the requirements: `pip install -r requirements.txt`
2. Start a OWASP DT instance locally (like via. Docker-Compose): https://docs.dependencytrack.org/getting-started/deploy-docker/
3. Run `./regenerate-api-client.sh`
4. Publish this library with the API version tag
