Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Shipped example configs and docs should use unique plugin IDs

Aperta
  • Qualcosa non va?
#263 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
markdown, python
Ambito
documentation, tooling

Direzione di ricerca

Start with EXAMPLE_PLUGINS in src/paperpi/example.py and the test that compares the generated example with paperpi.example.toml, then look at new_id in src/paperpi/web/plugins.py to see the existing ID form. The open questions about fixed versus random IDs and the config-check hint need a maintainer decision (txoof) before any edit. Done when the shipped example, docs and plugin READMEs use the agreed unique-ID form and tests cover it.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area:core area:docs enhancement needs-decision

Found in the web interface demo (2026-10-10): the demo's xkcd plugin had id = "comic", so its storage folder was plugins/comic/. That config was written by hand on 2026-10-09 (after the id decision of 2026-10-08, M5 part 3a-0, #251), copying the style of what PaperPi ships.

Problem: only the Plugin Library makes unique IDs (<type>-<8 random hex>, e.g. xkcd_comic-3f9a1c2e). Everything we ship shows short, readable IDs, so people (and agents) copy that style:

  • paperpi.example.toml (made by src/paperpi/example.py, EXAMPLE_PLUGINS): clock, weather_berlin, weather_rio
  • README.md, docs/writing-plugins.md, docs/decisions/config-format.md: clock, weather_berlin, word_clock
  • every plugin README in src/paperpi/plugins/*/README.md: clock, xkcd, moon, system, ...

Readable IDs are easy to repeat (two people's configs, a plugin added twice, an ID reused after removing a plugin), and a reused ID shares a storage folder with whatever used it before.

Wanted: the defaults we ship get unique-enough IDs, in the same form the Library makes.

To decide (ask txoof):

  • The example config is made again by paperpi example-config and a test compares it with the copy in the repository, so its IDs must be fixed values (for example basic_clock-5c1e0a7b), not new random ones each time. Fixed values in the example are copied by everyone who uses it as it is, so they are unique between plugins in one file, not between installs. Is that enough? Or should paperpi example-config (and the installer, M6) write fresh random IDs into the file it makes for the user, and only the copy in the repository use fixed ones?
  • Docs and plugin READMEs: use the same <type>-<hex> form in every example, or keep short readable IDs there and say clearly that the web interface makes unique ones?
  • Should the config check give a hint for an ID that doesn't have the <type>-<hex> form (hand-written IDs stay allowed)?

Where: src/paperpi/example.py (EXAMPLE_PLUGINS), paperpi.example.toml, src/paperpi/web/plugins.py (new_id, to share one way of making IDs), the docs and plugin READMEs above, maybe src/paperpi/config.py (hint).

Done when: what we ship uses unique-enough IDs as decided, the docs explain where IDs come from, and tests cover it.

Lingua principale
Python
Stelle
205
Fork
17
Merge medio
6h 12m
PR unite (30g)
44

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di txoof/PaperPi

Tutte le issue di txoof/PaperPi

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.