Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Command line: paperpi reload applies config changes and reports the result

オープン
#272 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
backend, cli

調査の方向性

Read src/paperpi/cli.py, health.py, and docs/decisions/live-config-reload.md to understand the existing signal and health report behavior. The issue leaves process discovery and result reporting undecided, so begin by tracing how paperpi run handles SIGHUP and how reload results are recorded. Done means paperpi reload reports applied, invalid config, or not running, with the specified exit status.

索引モデルが issue の本文から書いたものです。

説明

area:core enhancement

From the M5 part 4 design (web interface #238, Review changes page), agreed with txoof on 2026-10-11: a simple command to apply hand edits to the config file, so the web page (and the docs) can show one easy command.

Background: "reload" in PaperPi already means read the config file again and apply only what changed, without a restart (docs/decisions/live-config-reload.md). Unchanged plugins keep their data and their place in the order. Saving in the web interface uses exactly this. Today the only command-line ways to start it are kill -HUP <process id> or sudo systemctl reload paperpi (once PaperPi runs as a service). The design note already names a paperpi reload command, but it was never built.

Proposal

paperpi reload
  1. Finds the running paperpi run by itself (no process id to look up).
  2. Sends it the reload signal (SIGHUP).
  3. Waits a few seconds for the result and prints it:
    • applied (and, if possible, a short list of what changed, the same list as the web interface's Review changes page)
    • the config file has a mistake: line 42: ...; nothing changed, the old settings keep running
    • PaperPi is not running
  4. Exit status 0 when applied, 1 otherwise (so scripts and systemd can tell).

Works the same in the Docker container (docker exec paperpi paperpi reload, M6). The systemd service file can use it as its reload step (ExecReload=), so systemctl reload paperpi also reports a broken file.

To decide

  • How it finds the running PaperPi: the process id in the health report file (/run/paperpi/health, already written every 30 s), or a separate process id file.
  • How the result gets back to the command: e.g. the running PaperPi writes "last reload: time, result" into the health report, and paperpi reload waits until it changes (time limit about 15 s).
  • Whether it also gets a "check only" mode that names mistakes without applying anything.

Not part of the M5 part 4 PR. Until it exists, the Review changes page shows sudo systemctl reload paperpi or kill -HUP <process id>.

Area

core (src/paperpi/cli.py, health.py), docs (README, live-config-reload.md).

主要言語
Python
スター
205
フォーク
17
平均マージ
6時間 4分
マージ済み PR(30日)
45

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

txoof/PaperPi のほかの issue

txoof/PaperPi の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。