Install Poetry in Python Step by Step

Poetry is a powerful tool for managing Python dependencies and projects. It simplifies package management and virtual environments.

This guide will walk you through installing Poetry in Python. Follow each step carefully for a smooth setup.

Prerequisites

Before installing Poetry, ensure you have Python installed. Check your Python version using the command below.

# Check Python version
python --version

# Output example
Python 3.9.7

If you encounter ModuleNotFoundError, refer to our guide on solving ModuleNotFoundError.

Install Poetry

Poetry can be installed using the official installer script. Run the following command in your terminal.

# Install Poetry
curl -sSL https://install.python-poetry.org | python -

# Output example
Retrieving Poetry metadata...
Poetry (1.2.0) installed successfully.

This script downloads and installs the latest version of Poetry. It also adds Poetry to your system PATH.

Verify Installation

After installation, verify Poetry is working correctly. Use the command below to check the version.

# Check Poetry version
poetry --version

# Output example
Poetry version 1.2.0

If you see the version number, Poetry is installed correctly. If not, check your PATH settings.

Configure Poetry

Poetry can be configured to suit your needs. Use the config command to set preferences.

# Configure virtualenvs location
poetry config virtualenvs.in-project true

This command tells Poetry to create virtual environments inside your project folder. It keeps everything organized.

Create a New Project

Use Poetry to create a new Python project. Run the command below and follow the prompts.

# Create a new project
poetry new my_project

# Output example
Created package my_project in my_project

This creates a new project with a basic structure. It includes a pyproject.toml file for dependencies.

Add Dependencies

Add dependencies to your project using the add command. For example, add the requests library.

# Add a dependency
poetry add requests

# Output example
Using version ^2.26.0 for requests
Updating dependencies
Resolving dependencies...

Poetry automatically updates the pyproject.toml file. It also installs the dependency.

Install Existing Project

If you have an existing project, use the install command. It installs all dependencies.

# Install dependencies
poetry install

# Output example
Installing dependencies from lock file
No dependencies to install or update

This command reads the pyproject.toml file. It installs all listed dependencies.

Conclusion

Poetry is a great tool for managing Python projects. It simplifies dependency management and virtual environments.

Follow this guide to install and use Poetry effectively. It will save you time and keep your projects organized.

If you face issues like ModuleNotFoundError, check our guide on solving ModuleNotFoundError.