Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Plugins from an outside folder, each with its own packages (M6)

Đang mở
  • Có gì không ổn?
#326 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
backend, cli, documentation

Hướng nghiên cứu

Read the dependency issue #325 first, then inspect src/paperpi/plugins/__init__.py, src/paperpi/runner.py, and src/paperpi/cli.py, along with the web Library and install paths. The issue divides the work into outside plugin loading, the paperpi plugin commands and per-plugin packages, and an optional template repository. Completion means the agreed plugin layout and isolation work, the CLI commands are available, and the web interface and documentation reflect outside plugins.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Let other people build and share plugins without merging them into PaperPi's main. Replaces old #13 ("packaging plugin").

Decided

  • Outside plugins are folders in /opt/paperpi/plugins/ (root-owned, so a running plugin can't change itself or other plugins), with the same layout as the built-in ones (__init__.py with PLUGIN, README.md). The web interface shows them like built-in ones, marked as outside plugins. Updates of PaperPi don't touch them.
  • Added on the command line first: sudo paperpi plugin add <github url>, plus list, update, remove. Adding from the web interface maybe later.
  • Extra Python packages: each plugin lists them in a file in its folder; they go into its own folder /opt/paperpi/plugin-packages/<plugin>/, used only in that plugin's process. PaperPi's own packages (uv.lock) never change; on a version clash PaperPi's version wins and add warns.
  • System packages (apt): never installed by PaperPi; the plugin's README says what to install and setup="..." shows it in the web interface.

PRs
3. Outside plugin folder: loading, web Library, docs/writing-plugins.md.
4. paperpi plugin command with the per-plugin packages folder.
5. (optional) a plugin template repository to copy from.

Area: src/paperpi/plugins/__init__.py, src/paperpi/runner.py, src/paperpi/cli.py, web Library, docs, install (uninstall/paths). Comes after the install issue #325.

Ngôn ngữ chính
Python
Star
205
Fork
17
Merge trung bình
3 giờ 49 phút
Pull request đã merge (30 ngày)
89

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của txoof/PaperPi

Tất cả issue của txoof/PaperPi

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.