Metadata-Version: 2.4
Name: cmrelayinfo
Version: 0.1.1
Summary: report chatmail relay capabilities (iroh relay, TURN, maxsmtprecipients, quota)
Project-URL: Repository, https://github.com/hpk42/cmrelayinfo
Project-URL: Changelog, https://github.com/hpk42/cmrelayinfo/blob/main/CHANGELOG.md
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: deltachat-rpc-server>=2.24.0
Requires-Dist: deltachat-rpc-client>=2.24.0
Requires-Dist: xdg-base-dirs>=6.0.2
Dynamic: license-file

cmrelayinfo
===========

Report chatmail relay capabilities: iroh relay URL, TURN server,
maxsmtprecipients and storage quota.

For each relay, cmrelayinfo logs in with a chat profile that is
created once and then cached under `~/.cache/cmrelayinfo/`,
so repeated runs do not create new accounts on relays.

Usage
-----

```
cmrelayinfo                     # all relays from chatmail.at/relays (cached)
cmrelayinfo nine.testrun.org    # one specific relay
cmrelayinfo 116.203.128.59      # relay given as IP address
cmrelayinfo --json --refresh    # jsonlines output, refetch relay list
```

Installation
------------

```
uv tool install cmrelayinfo
```

Development
-----------

```
uv venv && uv pip install -e . --group test
uv run pytest
```

CI checks come from the shared
[chatmail/workflows](https://github.com/chatmail/workflows)
repository; run them locally with `uvx ruff check .` and
`uvx ruff format --check .`

To release, run the shared release script from a checkout of
chatmail/workflows:

```
python ../workflows/scripts/make_new_release.py
```

It runs the checks, tests the built wheel, writes the CHANGELOG.md
entry with git-cliff, then tags and pushes. The release.yml workflow
publishes to PyPI via trusted publishing (OIDC).
