carpentries-incubator / carpentries-incubator/python-intermediate-inflammation

Why use poetry for packaging?

Open Beginner friendly
#69 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
8
Forks
443
PR merge metrics
No merged PRs in 30d

Description

In section 4.3 Packaging Code for Release and Distribution `poetry` is used to package the code for release and distribution, but it also adds dependencies and I think it can be confusing...

The `pyproject.toml` already exists in the repo, otherwise `pip install -e .` would not work, so it is not clear why poetry is being used now.

Instead, I think the `pyproject.toml` file needs to be explained, and use `pip install build` and `python -m build` instead.

why using Poetry now instead of the tools that have been used before? Or alternatively, should poetry have been used in 1.2?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with section 4.3, “Packaging Code for Release and Distribution,” and inspect the existing pyproject.toml and the earlier pip install -e . instructions. Clarify why Poetry is used, or revise the section to use pip install build and python -m build; done means the packaging guidance and the relationship to section 1.2 are unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.