From 4c6a1191eee73101a94635a6e2ee3401278a9b4c Mon Sep 17 00:00:00 2001 From: Marcel Peterkau Date: Sun, 21 Jun 2026 15:04:06 +0200 Subject: [PATCH] first commit --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..10c012e --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# CCMA - Chaotic Creature Member Administration + +File-based member administration for Chaos Computer Club Mannheim e.V. + +The member store remains readable without this application. Every member has a +directory containing `member.json`, `contributions.json`, an append-only +`events.jsonl`, and a `files/` directory. + +## Development + +Requires Python 3.11+ with Tk support. + +```bash +python -m venv .venv +.venv/bin/pip install -r requirements.txt +.venv/bin/ccma +``` + +For development tools and tests, install the `dev` extra as well: + +```bash +.venv/bin/pip install -e '.[dev]' +``` + +Alternatively, without installation: + +```bash +PYTHONPATH=src python -m ccma +``` + +On first start, select or create the central member-store directory. The +`VERSION` file is the single source for application and package versions. + +## Store layout + +```text +member-store/ +├── repository.json +└── members/ + └── / + ├── member.json + ├── contributions.json + ├── events.jsonl + └── files/ +``` + +Do not place a real member store inside the source repository.