Poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you. Poetry offers a lockfile to ensure repeatable installs, and can build your project for distribution.
First, you need to install the poetry globally. There are several ways to install poetry. You can see the options on their documentation. I used pipx to install.
pipx install poetry
To check the version of poetry or update, use the below commands.
poetry --version
pipx upgrade poetry
There are different commands to start a new project, or add to the existing project. Later case for us.
Add poetry to the existing project
cd pre-existing-project
poetry init
If you run the command above, you will be asked for configuration of pyproject.toml file like below screenshot.
You can add packages in this setup process, or later add manually.
Hit Enter at last, then it will automatically create pyproject.toml file in your project root directory.
You maybe need virtual environment for your project. you can either create your own, or let poetry to create one.
By default, Poetry creates a virtual environment in {cache-dir}/virtualenvs. You can change the cache-dir value by editing the Poetry configuration. Additionally, you can use the virtualenvs.in-project configuration variable to create virtual environments within your project directory.
In my case, I just run poetry shell and it automatically find the python version and create .venv like screenshot below.
After that, run poetry install to install the dependencies for your project. It will automatically create the poetry.lock file.
Possible Confusion
You are probably used to use pip. Then, you maybe confuse install command for poetry. With poetry, install command reads the pyproject.toml file from the current project, and installs them.
To install the package like pip install poetry uses add command. Like, poetry add <package name>
I am not explaining how it works and why it is structured like that in details. You can see poetry documentation of managing dependencies.
If you run poetry install right away, You will get errors like below.
There are two options to solve this.
As you can see from the msg, you can run poetry lock --no-update to overwrite the lock file. Then, run poetry install again.
Or you can just simply delete the lock file and run poetry install again.
Then, it will install all the packages.
I still had same pylance error. In my case, I needed to restart the vscode. now it is gone.
Probably, some of you still have pylance error, reportMissingImports. In that case, please check the env list by this command.
poetry env list
You might have the random name of the virtualenv. Try run the below command and restart the vscode.
poetry config virtualenvs.in-project true
Export to requirements files for docker to catch all the packages
This needs to be done whenever you add package with poetry, I guess…… Not sure though…
Probably, when the docker is building, docker is trying to install the packages from the requirements files. base.txt, local.txt, and production.txt for production server. So, we need to export the pyproject.toml to those files. Use the below commands one by one to export them.
