Metadata-Version: 2.4
Name: pyimprint
Version: 0.2.0
Summary: PyImprint — a Python library.
Keywords: pyimprint,stamp,pdf,seal
Author: Flinn Fuchs
Author-email: Flinn Fuchs <47865376+DiscoveryFox@users.noreply.github.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: pyimprint[raster] ; extra == 'all'
Requires-Dist: pyimprint[pdf] ; extra == 'all'
Requires-Dist: pyimprint[web] ; extra == 'all'
Requires-Dist: reportlab>=4.0 ; extra == 'pdf'
Requires-Dist: pypdf>=5.0 ; extra == 'pdf'
Requires-Dist: pillow>=10.0 ; extra == 'raster'
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/DiscoveryFox/pyimprint
Project-URL: Repository, https://github.com/DiscoveryFox/pyimprint
Project-URL: Issues, https://github.com/DiscoveryFox/pyimprint/issues
Provides-Extra: all
Provides-Extra: pdf
Provides-Extra: raster
Provides-Extra: web
Description-Content-Type: text/markdown

# PyImprint

> _Placeholder description — replace this once the library takes shape._

[![CI](https://github.com/DiscoveryFox/pyimprint/actions/workflows/ci.yml/badge.svg)](https://github.com/DiscoveryFox/pyimprint/actions/workflows/ci.yml)
[![Publish](https://github.com/DiscoveryFox/pyimprint/actions/workflows/publish.yml/badge.svg)](https://github.com/DiscoveryFox/pyimprint/actions/workflows/publish.yml)
[![PyPI](https://img.shields.io/pypi/v/pyimprint)](https://pypi.org/project/pyimprint/)
[![Python](https://img.shields.io/pypi/pyversions/pyimprint)](https://pypi.org/project/pyimprint/)
[![License](https://img.shields.io/pypi/l/pyimprint)](https://github.com/DiscoveryFox/pyimprint/blob/main/LICENSE)

## Installation

```bash
pip install pyimprint
```

Or with [uv](https://docs.astral.sh/uv/):

```bash
uv add pyimprint
```

## Usage

```python
import pyimprint

print(pyimprint.__version__)
```

## Development

This project uses [uv](https://docs.astral.sh/uv/) for dependency management and
packaging. Clone the repository and install the dev dependencies:

```bash
git clone https://github.com/DiscoveryFox/pyimprint.git
cd pyimprint
uv sync
```

### Common tasks

| Task | Command |
| --- | --- |
| Run tests | `uv run pytest` |
| Lint | `uv run ruff check` |
| Format check | `uv run ruff format --check` |
| Type check | `uv run mypy src/pyimprint` |
| Build | `uv build` |

## Publishing

Releases to [PyPI](https://pypi.org/project/pyimprint/) are published
automatically by the `publish.yml` GitHub Actions workflow whenever a tag
matching `v*` (e.g. `v0.1.0`) is pushed.

To cut a release:

```bash
git tag v0.1.0
git push origin v0.1.0
```

> **Note:** Publishing uses [OIDC trusted publishing](https://docs.pypi.org/trusted-publishers/) — no API token needed. Configure a pending publisher on PyPI before the first release: **pypi.org → Account settings → Publishing → Add a pending publisher** with owner `DiscoveryFox`, repository `PyImprint`, and workflow `publish.yml`.

## License

[MIT](LICENSE)
