Poetry

Homepage

Basic usage

New project

$ poetry new poetry-demo

• pyproject.yml

    [tool.poetry]
    name = "poetry-demo"
    version = "0.1.0"
    description = ""
    authors = ["Sébastien Eustace <sebastien@eustace.io>"]
  
    [tool.poetry.dependencies]
    python = "*"
  
    [tool.poetry.dev-dependencies]
    pytest = "^3.4"
  

Existing project

$ poetry init

Add dependency

Add to this section:

• pyproject.yml

    [tool.poetry.dependencies]
    pendulum = "^1.4"
  

Or run

$ poetry add pendulum

Virtual environments

By default, Poetry creates an environment here:

• {cache-dir}/virtualenvs

That uses the Cache directory.

• macOS - ~/Library/Application Support/pypoetry
• Windows - C:\Users\<username>\AppData\Roaming\pypoetry

Run commands

$ poetry run python your_script.py

$ poetry run pytest

Activate environment

This creates a subshell, so when you exit the subshell no changes are persisted.

$ poetry shell

Or

$ source {path_to_venv}/bin/activate

> source {path_to_venv}\Scripts\activate.bat

And deactivate with:

$ deactivate