Python Packages Project Generator VS PDM

- python-package-template

Hey HN, this would be more of an early release (still planning on some tweaks before a release) -- would love to hear your thoughts on this!

For some back-story, this is more of a side-side-project (made this while working on another side-project).

When I switched to using Go for my projects (from Python), the lack of a template generator similar to python-package-template[1] was very annoying. I would copy the basic files (Makefile, Github actions, PR templates, etc) from the previous project only to realize I forgot to change some stuff, and now would need to rewrite git history.

By the third project, I decided to create a template generator for Go! I've tried to keep the generated project as flexible as possible - you can decide to skip the of it and go for a simple project, or take the bloat (pre-commit would need Python for one).

While making go-template, one of my side goals has been to keep the project beginner-friendly. I remember stumbling upon python-package-template[1] as a novice, and learning more than I had in a semester - Makefiles, linters, code-formatters, semantic versioning, pipelines, and so much more! With go-template, I hope to give that same experience to some other newbie who might stumble upon my repo (or a project generated using go-template).

As a fun fact, go-template has an option to remove Github-specific-features (pull request templates, workflows, etc). This was inspired by a comment on HN[2] pointing out that many open-source projects were on Github simply because of FOMO, which in-turn promoted Github's dominance!

[1]: https://github.com/TezRomacH/python-package-template

Oh, and if I am not mistaken, you have also used the python-package-template itself to generate goli structure 🔥

CookieCutter or Kedro are the winners. I still think we will stick to Kedro template, because it offers extra functionality, and I like to think of each project as a set of pipelines to be run. Anyway, some cookiecutter templates are very good, like this one. In case we use both Kedro and ClearML, we'll have to figure out how to integrate its pipelines with ClearML tasks. But in the slack channel of ClearML there are other teams doing the same, so at least it's possible.

# See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v3.2.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: check-toml - id: check-added-large-files - repo: local hooks: - id: tox lint name: tox-validation entry: pdm run tox -e test,lint language: system files: ^src\/.+py$|pyproject.toml|^tests\/.+py$ types_or: [python, toml] pass_filenames: false - id: tox docs name: tox-docs language: system entry: pdm run tox -e docs types_or: [python, rst, toml] files: ^src\/.+py$|pyproject.toml|^docs\/ pass_filenames: false - repo: https://github.com/pdm-project/pdm rev: 2.10.4 # a PDM release exposing the hook hooks: - id: pdm-lock-check - repo: https://github.com/jumanjihouse/pre-commit-hooks rev: 3.0.0 hooks: - id: markdownlint

PDM is a solution that allows for easy creation and management of python projects. Some of the key features that will improve the management of python projects include:

You'd need a proper dependencies management tool like PDM or Poetry to exhaustively resolve and lock down all the transitive dependencies if you want to have anything closed to reproducible build.

Are you working on a Python project that uses pdm for dependency management and dotenv for local environment variable and secrets management? Do you find it frustrating when CLI tools like pgcli don't automatically pick up your .env file, forcing you to resort to npm install -g dotenv-cli? I've got a more convenient solution for you!

I first learned about PDM from a blog post written by one of the PDM contributers. The post was about OOPifying argparse to allow for easy creation/modification of subcommands that exist as their own classes/files, and to avoid maintaining a single long script with an endless number of subparser.add_argument(...) lines.

That's more or less what PEP 582 plans to do, but it's been stalled and mired in discussions for years. The PDM tool went ahead and implemented it though if you want to use it: https://github.com/pdm-project/pdm

pdm – A modern Python package and dependency manager

pdm and PEP 582 enter the chat

I'm liking PDM for a while now. Quicker than Poetry and built according to the Python package spec in mind and not as an afterthought. While it was originally meant to work with PEP 582, it works with virtual environments too (now default).

https://github.com/pdm-project/pdm