> For the complete documentation index, see [llms.txt](https://docs.paradime.io/app-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.paradime.io/app-help/developers/virtual-environments/using-poetry.md).

# Using Poetry

{% embed url="<https://python-poetry.org/>" %}

Poetry is a tool for **dependency management** and **packaging** in Python. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you.

### Initialize a new project

This command starts an interactive process to create a new `pyproject.toml` file. It guides you through defining your project's metadata, including name, version, description, author, license, and dependencies.

```bash
poetry init
```

### Install project dependencies

This command reads the `pyproject.toml` file in your project, resolves the dependencies, and installs them into a new virtual environment.

If a `poetry.lock` file exists, it uses this to ensure reproducible installations across different environments.

```bash
poetry install
```

### Enter the virtual environment

This command spawns a new shell with the virtual environment activated. It allows you to run your project and its dependencies in an isolated environment, ensuring that you're using the correct versions of all packages.

```bash
poetry shell
```

### Deactivate the virtual environment

To exit the Poetry shell and deactivate the virtual environment, you can use:

```bash
exit
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.paradime.io/app-help/developers/virtual-environments/using-poetry.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
