Developing Python packages with Poetry and Package Helper 3

Speaker : Fabien Mathieu
Swapcard
Date: 15/11/2023
Time: 10:30 am - 11:30 am
Location: Salle 4B01

Abstract

When you develop a Python project, it is highly recommended that you design it as a Python package, which gives you access to a variety of powerful development tools. With Package Helper 3 (https://balouf.github.io/package-helper-3/), it is easy and fast to do it! Things will go this way:

  • PH3 helps you to create the file structure of your package in less than a minute.
  • Using PyCharm, you can out-of-the-box:
    • Generate the documentation locally,
    • Run tests,
    • Have a “coverage” page, which displays what parts of the package are covered by the tests.
  • Your project is hosted on GitHub, which is configured to automatically run the tests with several versions of Python and to automatically generate and publish the documentation.
  • When desired, GitHub publishes your package on PyPI, so that any Python user can install it.

Under the hood, the management of your package will be performed by Poetry, a modern tool that unifies and simplifies the tasks required to develop a package, such as installing a dedicated development environment, making installation easy for other users, building wheels, managing and updating dependencies…

Tutorial: https://balouf.github.io/package-helper-3/tutorial.html.