Why use poetry for packaging?

Open Beginner friendly
#69 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

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?

Dominant language
Python
Stars
8
Forks
443
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from carpentries-incubator/python-intermediate-inflammation

All issues in carpentries-incubator/python-intermediate-inflammation

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.