Skip to content

Getting Started

Introduction

Poetry PyInstaller Plugin is a lightweight extension for Poetry that makes packaging Python applications into standalone executables effortless.

It bridges the gap between Poetry’s dependency management and PyInstaller binary packaging, letting you build distributable apps directly from your Poetry project without leaving the familiar poetry workflow.

With a single command, you can bundle your Python project (including all dependencies and metadata) into a platform-native executable, perfect for distribution to users without Python installed.

Project Links

Installation

To install poetry-pyinstaller-plugin add the following section to your pyproject.toml

pyproject.toml
[tool.poetry.requires-plugins]
poetry-pyinstaller-plugin = { version = ">=2.0.0,<3.0.0", extras = ["plugin"] }

To complete the installation: 

poetry add --group dev pyinstaller
poetry install
Well done, your project is ready for pyinstaller builds !

Depending on installation method, use one of the following command:

Installed with pip or debian package
poetry self add poetry-pyinstaller-plugin
Or

Installed with pipx
pipx inject poetry poetry-pyinstaller-plugin

To complete the installation: 

poetry add --group dev pyinstaller
poetry install
Well done, your project is ready for pyinstaller builds !

Info

If you are having troubles installing the plugin please refer to Poetry documentation - Using Plugins

Check plugin version

To check plugin installation you can run the following command:

Shell
$ poetry pyinstaller show
poetry-pyinstaller-plugin x.x.x