Warning

** Poetry should always be installed in a dedicated virtual environment to isolate it from the rest of your system. **

How to install ?

https://python-poetry.org/docs/#installation

conda create -n poetry python=3.11

Basics

Project Setup: Initialize new projects or existing directories with Poetry, creating a pyproject.toml file for configuration.
Specifying Dependencies: Manage project dependencies through pyproject.toml, using the poetry add command for easy addition.
Virtual Environment: Poetry automatically creates and manages virtual environments, with commands for activation and script execution within these environments.
Version Constraints: Define dependency versions using various constraints to ensure compatibility.
Installing Dependencies: Install project dependencies with or without a poetry.lock file, ensuring consistent dependency versions across environments.
Updating Dependencies: Update dependencies to their latest versions while respecting version constraints in pyproject.toml.

Code Examples:

Create a new project: poetry new poetry-demo
Add a dependency: poetry add pendulum
Activate virtual environment: poetry shell

For a detailed explanation and more examples, visit the Poetry Basic Usage Documentation

Do not forget

Since this is the top StackOverflow result for "poetry command not found"...

For Mac users and zsh users, create a .zshrc file in your home folder with the following:

export PATH="$HOME/.local/bin:$PATH"

# In tests/test_erdem.py
import unittest

  

def sum(a, b):

return a + b

  

class TestSum(unittest.TestCase):

def test_sum(self):

self.assertEqual(sum(1, 2), 3)

  

def test_sum_negative(self):

self.assertEqual(sum(-1, 1), 0)

  

if __name__ == '__main__':

unittest.main()

poetry run pytest

Install conda and poetry

https://medium.com/@silvinohenriqueteixeiramalta/conda-and-poetry-a-harmonious-fusion-8116895b6380

Install conda install pytest for run poetry run pytest

Managing Dependencies

The "Managing Dependencies" page on the Poetry documentation provides guidance on how to organize and manage dependencies in Python projects using Poetry. Key points include:

Dependency Groups: Dependencies can be organized into groups (e.g., main, test, docs) for better organization and optional installation.
Optional Groups: Some groups can be marked as optional, meaning they are not installed by default but can be included with specific install commands.
Adding/Removing Dependencies: The poetry add and poetry remove commands are used to add or remove dependencies to/from specific groups.
Installing Group Dependencies: The poetry install command supports various options (--with, --without, --only) to control which groups of dependencies are installed.
Synchronizing Dependencies: The --sync option ensures that only the dependencies specified in the poetry.lock file are present, removing unneeded ones.
Layering Optional Groups: You can install subsets of optional groups without removing those already installed, useful in scenarios like multi-stage Docker builds.

For code examples and more detailed explanations, please refer to the Poetry Documentation.

Here are some code examples from the Poetry documentation on managing dependencies:

Adding a Dependency:
```
poetry add requests
```
This adds the "requests" library to your project's dependencies.
Adding a Dependency to a Specific Group:
```
poetry add pytest --group dev
```
This adds "pytest" to the "dev" group, typically used for development dependencies.
Installing Only Specific Groups of Dependencies:
```
poetry install --only main
```
Installs only the dependencies in the "main" group.
Removing a Dependency:
```
poetry remove requests
```
This removes the "requests" library from your project's dependencies.

For more examples and a detailed explanation of each command, you can refer to the Poetry Documentation on Managing Dependencies.

As an example, 1.0.0-hotfix.1 is not compatible with PEP 440. You can instead choose to use 1.0.0-post1 or 1.0.0.post1.

Libraries

The "Libraries" section of the Poetry documentation covers key aspects of making your library installable through Poetry. It details topics like versioning in compliance with PEP 440, managing the lock file, packaging the library for distribution, and publishing to both PyPI and private repositories. The section provides practical commands for these processes:

Packaging your library: poetry build
Publishing to PyPI: poetry publish
Publishing to a private repository: poetry publish -r my-repository

For more detailed information and examples, refer to the Poetry Documentation on Libraries

CLI

The "Commands" section of the Poetry documentation provides comprehensive details on various commands available in Poetry, a Python dependency management and packaging tool. It includes commands for project initialization (new, init), dependency management (add, remove, install, update), and other operations like building (build), publishing (publish), and configuring settings (config). Each command is explained with its purpose and usage, along with options to customize their behavior. This section is essential for understanding how to effectively use Poetry for Python project management.

For detailed usage and examples of each command, you can refer to the Poetry CLI Documentation.

6.1 KiB Raw Blame History