Step 1 of moving the repo to Python with declarative rules. - core/spec/form.yaml: every question (how it is found in an export), every answer and what it is coded as, missing answers, email redaction, burn order, first-dragon pools. - core/atlas/coding.py reads it and replaces core/python/clean.py (python -m atlas.coding). - tests/core/test_coding.py: 16 rule tests, one hand-written row per rule, checking the rules are right rather than only that JS and Python agree. - analysis/stats/analyze.py takes the colours and missing answers from the spec instead of its own copy; the daily update job codes rows through the package. - pyproject.toml for the package; pyyaml and pytest added to requirements. The coded runs are byte-identical to before (5,988 runs); all parity checks still match. Claude-Session: https://claude.ai/code/session_01UCzTd31GphpMXDhQqWrCMQ Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
35 lines
1.7 KiB
Markdown
35 lines
1.7 KiB
Markdown
# Privacy and licences
|
|
|
|
Rules every part of the project follows. If a change would break one, stop and ask first.
|
|
|
|
## What may be published
|
|
|
|
- **Code** is MIT (`LICENSE`). **Data this project produces** is CC BY 4.0 (`DATA_LICENSE.md`). Third-party
|
|
sources keep their own terms.
|
|
- **Community form responses:** published as exported, with email addresses in free-text answers redacted by
|
|
the coding rules (`core/spec/form.yaml`, `core/atlas/coding.py`).
|
|
- **Dragon Register:** only `data/public/register.json`. The raw export has rider names and stays local
|
|
(`data/raw/register/` is git-ignored).
|
|
- **The community route PDF:** never committed or redistributed. Only a fingerprint
|
|
(`data/derived/pdf_fingerprint.json`) so we can tell when it changes, and a link to the original.
|
|
- **Bot data:** only scene fingerprints, short labels, choice text and outcomes. Never game prose, never account
|
|
names. The importer (`collection/bot/bot.js`) refuses to write anything that looks like either.
|
|
|
|
## The bot
|
|
|
|
- Ken's bot repository stays private. Only the anonymised import comes here.
|
|
- Account ids are salted and hashed. The salt (`DK_ACCOUNT_SALT`) lives in the environment and is never
|
|
committed.
|
|
- The bot's browser profiles, `.env` and credential files are never committed or shared.
|
|
|
|
## Sources we do not scrape
|
|
|
|
- **Discord:** not without the server admins' consent; never with a personal account token.
|
|
- **Reddit:** not collected yet. When it is, it should go through Reddit's official API with an app key, not page
|
|
scraping.
|
|
|
|
## Secrets
|
|
|
|
- `ATLAS_BOT_TOKEN` (repository secret) lets the daily data update open and auto-merge its pull request
|
|
(`docs/REPO_SETTINGS.md`). Tokens go in secrets only: never in a file, issue, chat or commit.
|