python-poetry / python-poetry/poetry

(🎁) Provide a wrapper script entry point (like Gradle does with the Gradle wrapper)

Open
#4,988 5 comments 16 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature status/triage
Dominant language
Python
Stars
34.3k
Forks
2.5k
Avg merge
2d 19h
Merged PRs (30d)
30

Description

  • I have searched the issues of this repo and believe that this is not a duplicate.
  • I have searched the documentation and believe that my question is not covered.

Feature Request

Working on a Gradle project is super easy because to install dependencies/build/run all you have to do is use the Gradle wrapper script that is committed with the project as an entry point, eg: ./gradlew build. It would be great if Poetry had something similar to ease the setup process when Poetry itself isn't installed. Currently you have to mess around with the Poetry install script or use pipx or something, coming from Gradle this all seems like so much work.

This is also a big hassle when different projects(or branches with projects) use different versions of poetry.

Gradle Wrapper

Solution

Use Pyprojectx

[tool.pyprojectx]
poetry = "poetry==1.6.1"
> ./pw poetry install

Does the poetry team want to update the docs to suggest Pyprojectx?

Contributor guide

Open the contributing guide

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.

Research direction

Start by reading the issue's Gradle Wrapper and Pyprojectx references, then inspect the Poetry documentation and the proposed pyproject.toml configuration. Clarify whether the project should provide its own wrapper entry point or document Pyprojectx. Done means the chosen approach supports project-specific Poetry versions and has documented setup and usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.