Poetry

Poetry is a package builder, dependency and virtual environment manager for python.

Installation

conda install -c conda-forge poetry

Alternatvie installation instructions: python-poetry.org

Basic usage

Set-up project

poetry new "my_project_name"

Installs poetry virtual environment and sets up the required files for poetry to work. pyproject.toml contains the configuration for poetry and the needed dependencies. The new folder is there for your source code.

Adding / installing single dependencies

poetry add package_name

Uses pip to install the new package to your virtual environment and adds it to your dependencies list.

Installing the dependencies from the .toml-file

poetry install

Running code with poetry

There are two options:

1. Using poetry command

   poetry run python your_script.py

2. Activating the poetry shell

   poetry shell

Using Jupyter-Notebooks in VS-Code

1. List the directory of your python interpreter:

poetry env info --path

2. In python-file,

   1. on bottom right of VS-Code window click on python-version.

   2. In new dialogue “Select Interpreter”, click “+ Enter interpreter path”

   3. Paste the interpreter path into the text-box.

3. In jupyter-notebook,

   1. Select kernel

   2. Select Python environment

   3. Select the python interpreter that you just listed before.

Build and publish your package

Build package

poetry build

This will package your file as sdist and wheel format.

Publish to PyPI

poetry publish