Skip to content

docs: add existing project quickstart - #11088

Open
Mohamedajab wants to merge 4 commits into
python-poetry:mainfrom
Mohamedajab:docs/existing-project-quickstart
Open

Mohamedajab wants to merge 4 commits into
python-poetry:mainfrom
Mohamedajab:docs/existing-project-quickstart

Conversation

@Mohamedajab

Copy link
Copy Markdown
Contributor

Adds a short quickstart for contributors joining an existing Poetry project. It explains installing from pyproject.toml and poetry.lock, running commands in the project environment, and updating dependencies through Poetry.

Resolves #8131

Pull Request Check List

  • Added tests for changed code.
  • Updated documentation for changed code.

sourcery-ai[bot]
sourcery-ai Bot previously approved these changes Sep 22, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/basic-usage.md" line_range="36-37" />
<code_context>
+poetry run pytest
+```
+
+Alternatively, use [`poetry env activate`]({{< relref "managing-environments#activating-the-environment" >}})
+to print the command that activates the environment in your shell.
+
+To add or remove a dependency, use [`poetry add`]({{< relref "cli#add" >}}) or
</code_context>
<issue_to_address>
**nitpick:** The quickstart tells users to run `poetry env activate` but only explains that it prints an activation command; running it by itself leaves the current shell unactivated, so users who follow this alternative do not enter the project's environment.

**Triggers:** When a contributor chooses shell activation instead of `poetry run`.

**Suggested fix:** Show how to evaluate the output for the relevant shell, such as `eval "$(poetry env activate)"` for Bash/Zsh, or explicitly tell users to run the printed command.

````suggestion
Alternatively, in Bash or Zsh, evaluate the output of [`poetry env activate`]({{< relref "managing-environments#activating-the-environment" >}}):

```bash
eval "$(poetry env activate)"
```
````
</issue_to_address>

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/basic-usage.md Outdated

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant