Metadata-Version: 2.5
Name: clankers
Version: 0.0.0
Summary: Small Python library to automatically send notifications using the ntfy service
Project-URL: Repository, https://github.com/radajakub/clankers
Project-URL: Issues, https://github.com/radajakub/clankers/issues
Project-URL: Changelog, https://github.com/radajakub/clankers/blob/master/CHANGELOG.md
Author-email: Jakub Rada <dev.jakubrada@icloud.com>
License-Expression: MIT
License-File: LICENSE
Keywords: alerts,monitoring,notifications,ntfy,push-notifications
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Communications
Classifier: Topic :: System :: Monitoring
Classifier: Typing :: Typed
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# clankers

Small Python library to automatically send notifications using ntfy service

## Development

```bash
uv sync --group dev
make check   # ruff lint + format check + prettier
make fix     # autofix and reformat
make test    # pytest
make build   # wheel + sdist into dist/, validated with twine
```

## Releasing

`make release VERSION=0.1.0` runs `scripts/release.py`, which bumps the version in `pyproject.toml`,
opens a dated section in `CHANGELOG.md`, commits, tags `v0.1.0`, pushes, and publishes a GitHub
Release. The Release event triggers `.github/workflows/publish.yml`, which builds and uploads to PyPI
via Trusted Publishing. It refuses to run unless you are on `master` with a clean tree in sync with
origin and the tag is unused.

Use `make release-dry-run VERSION=0.1.0` first to print every step without changing anything.

Describe changes under `## [Unreleased]` in `CHANGELOG.md` before releasing — that section becomes
the release notes.

One-time setup on [pypi.org](https://pypi.org/manage/account/publishing/): add a trusted publisher
for project `clankers` with owner `radajakub`, repository `clankers`, workflow `publish.yml` and
environment `pypi`.
