Skip to content

"Basic Usage" guide may include specific instructions for existing poetry projects #8131

@Zocker1999NET

Description

@Zocker1999NET
  • I have searched the issues of this repo and believe that this is not a duplicate.

Background

I am very new to poetry. I bumped into a first project I want to contribute to which uses poetry. So, to contribute to that project, I needed/wanted to learn on how to use poetry in the first place.

Issue

Currently, the basic usage guide seems targeted to users who discovered poetry and want to apply it to a project of their own (either a completely new one or an already existing one).
That is different from when you first bump into a project, which already uses poetry, which IMO may happen more often.

So I think it makes sense to build another variant of a "basic usage" guide targeted to "users" which only want to contribute to a project using poetry, as most parts of the current "basic usage" don't apply to them. IMO it should answer following questions:

  • Can poetry help you to set up a venv with all listed requirements?
    • yes
  • How can you use it?
    • poetry install && poetry shell (mind shell will open a new subshell because …)
  • What if I want to add another requirement?
    • poetry add or edit pyproject.toml manually
  • Any other parts I might have missed which might be important to "users" as well
  • What if I want to set up a new project?
    • link to the current basic usage guide

Alternative Solution

Maybe its good enough to add just a small section with an header explaining which parts of basic usage are most relevant if trying to use poetry on an already existing and configured project.

Metadata

Metadata

Assignees

Labels

area/docsDocumentation issues/improvementsstatus/triageThis issue needs to be triaged

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions