Metadata-Version: 2.5
Name: ironeye
Version: 1.0.0
Summary: Official Python client for the IronEye document intelligence and collection API.
Project-URL: Documentation, https://ironeye.org/docs/sdk/python
Project-URL: Homepage, https://ironeye.org
Project-URL: Repository, https://github.com/IronEyeAPI/ironeye-python
Project-URL: Issues, https://github.com/IronEyeAPI/ironeye-python/issues
Author: Direct Softworks
License-Expression: MIT
License-File: LICENSE
Keywords: document,gdpr,ironeye,malware,osint,pii,secrets
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27
Description-Content-Type: text/markdown

# IronEye for Python

The official Python client for the [IronEye](https://ironeye.org) API: document
analysis over bytes you send, and normalised collection from public sources,
behind one key.

```sh
pip install ironeye
```

## Features

- Synchronous and `async` clients over one shared transport, so the two cannot
  drift apart.
- Every analysis route, the async job path with `await_job`, the collection
  catalogue and the data-subject-rights endpoints.
- `TypedDict` models, and one exception class per refusal family.
- Retries on the server's own `retryable` flag, honouring `Retry-After`.
- Logs to the `ironeye` logger. No credential, no payload.

Full documentation, including every endpoint and every option, is at
**https://ironeye.org/docs/sdk/python**.

---

Direct Softworks · [MIT](LICENSE) · issues and pull requests welcome
