Document the `python` and `poetry` plugins
Metadata
Current evaluation
Python and Poetry plugin docs were merged in #1940 (408650c8), with charm-to-Python/Poetry migration guides added in #1967 (ff00a899).
Resolution: closed resolved
Reason: Documentation was completed by merged PR #1940 (commit 408650c8). The maintainer-requested migration guidance was added by merged PR #1967 (commit ff00a899).
Evaluated by: mr-cal-bot
No scores available.
Issue body
### What needs to get done
Write documentation on how to use the `python` and `poetry` plugins.
### Why it needs to get done
They need to be documented before we release charmcraft 3.3
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Python and Poetry plugin docs were merged in #1940 (408650c8), with charm-to-Python/Poetry migration guides added in #1967 (ff00a899). | |
| stealth/space-bunny-alpha | — | closed resolved | Python and Poetry plugin docs were merged in #1940 (408650c8); #1967 (ff00a899) added charm-to-Python and charm-to-Poetry migration guides. | |
| stealth/space-bunny-alpha | — | closed resolved | Python and Poetry plugin reference docs merged in #1940 (408650c8); migration guides were added in #1967 (ff00a899). | |
| stealth/space-bunny-alpha | — | closed resolved | Documentation was added in PR #1940 (408650c8); PR #1967 (ff00a899) added Charm-to-Python and Charm-to-Poetry migration guides. | |
| stealth/space-bunny-alpha | — | closed resolved | Python and Poetry plugin docs merged in #1940 (408650c8); #1967 (ff00a899) added charm-to-Python and charm-to-Poetry migration guides. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without documentation being added. The request to document the python and poetry plugins was deferred to internal Jira tracking (CRAFT-3425) and appears abandoned, with no pull request or resolution merged. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed as completed after internal Jira tracking and scope clarification to include a reference and migration guide. No linked merge or fix was provided. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed. Documentation for the python and poetry plugins was superseded by internal Jira ticket CRAFT-3425. Maintainer feedback specified reference and migration content, but no documentation was produced. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without implementation. Superseded by internal Jira ticket CRAFT-3425. Documentation scope was refined to include a reference guide and migration instructions from the charm plugin to poetry. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/charmcraft#1940
(confidence 100%)
Added reference documentation for the Python and Poetry plugins.
-
Likely Fixed By:
canonical/charmcraft#1967
(confidence 100%)
Added the requested guides for migrating from the charm plugin to Python and Poetry.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1940 feat(docs): add python and poetry plugin docs | charmcraft | merged | PR #1940 merged as commit 408650c8, adding Python and Poetry plugin documentation (+144 lines, 6 files). Builds on #1939 (craft-parts common docs) and required craft-parts#872 anchors; merged despite12 unresolved review comments. | |
| #1873 Create charmcraft-specific versions of the upstream `python` and `poetry` plugins | charmcraft | closed | Charmcraft-specific Python and Poetry plugins were added by merged PR #1899 (commit 8b748f3e), replacing the experimental work in #1840. | |
| #1967 docs: add howto guides for switching from the charm plugin | charmcraft | merged | Merged as ff00a899, adding migration guides from the charm plugin to the Python and Poetry plugins. A dispatch regression found during testing was fixed in #1972. | |
| #1843 Add charmcraft-specific versions of upstream python plugins | charmcraft | open | Request to add charmcraft-specific python/poetry plugins. Implemented by commit 8b748f3e (PR #1899) alongside #1873; the plugins are registered as 'python'/'poetry' in get_app_plugins() and have received later fixes (#1968, #2044, #2835). | |
| #809 Reference documenation for the poetry plugin | craft-parts | closed | Added Poetry plugin reference documentation in merged PR canonical/craft-parts#830 (commit aec88860), resolving the missing documentation request. | |
| #830 feat(docs): add poetry plugin reference | craft-parts | merged | Merged PR #830 as commit aec88860, adding Poetry plugin reference documentation across three files (+107/-1), following the plugin introduced in #820. | |
| #1899 feat: add Python and Poetry plugins | charmcraft | merged | Merged into main via commit 8b748f3e, adding Charmcraft-specific Python and Poetry plugins with charm-oriented venv, pip, source-copy, and binary defaults. | |
| #1840 [EXPERIMENTAL]: poetry plugin | charmcraft | closed | Experimental Poetry plugin PR closed unmerged in favour of charmcraft#1899, merged as commit 8b748f3e, adding charmcraft/parts/plugins/_poetry.py and _python.py with charm-oriented defaults. | |
| #1939 feat(docs): add craft-parts common documentation | charmcraft | merged | Merged as 534c028f, adding shared craft-parts documentation across eight files and laying groundwork for Python and Poetry plugin guides in #1940. |