python-poetry / python-poetry/poetry

Implement a `poetry report <command>` command or something similar for when filing issues

Open
#9,680 0 comments 0 reactions 1 assignee View on GitHub

@Secrus is already working on this.

Since Sep 26, 2024.

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

Description

Issue Kind

Brand new capability

Description

When filing issues, users are asked to run several easily scriptable commands. This is quite tedious on the user and creates a barrier for appropriately filing bug reports.

Instead, Poetry should ship with some sort of debug command that would wrap everything up into a single command that would then be printed out or put into a Zip file.

For example, here are the separate commands users are asked to run:

poetry --version
poetry config --list
python -m sysconfig
<copy of the pyproject.toml>
poetry -vvv <command>

This is a bit tedious. So, a command such as

poetry report <command> [--include-pyproject-toml]

could be implemented that bundles up all of the requested output into a single command. It could also put the report into a text or HTML file to be uploaded when filing bug reports. Having a flag such as --sanitizer-user <user> could remove usernames from the paths that are printed.

Impact

The existing behavior creates a barrier to properly filed bug reports or even bug reports being filed at all.

Workarounds

Manually run all the requested commands.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.