# Best engineering practices for a Python package: seeking feedback

**URL:** <https://discuss.python.org/t/best-engineering-practices-for-a-python-package-seeking-feedback/10956>\
**Category:** Python Help\
**Created:** [October 4, 2021, 8:36pm UTC](https://discuss.python.org/t/best-engineering-practices-for-a-python-package-seeking-feedback/10956 "2021-10-04T20:36:15Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![jens](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/jens/32/5052_2.png) [@jens](https://discuss.python.org/u/jens)\
**Post date:** [October 4, 2021, 8:36pm UTC](https://discuss.python.org/t/best-engineering-practices-for-a-python-package-seeking-feedback/10956/1 "2021-10-04T20:36:15Z")

</div>

Hello everyone,

I’ve created a cookiecutter template for a Python package [on Github](https://github.com/jenstroeger/python-package-template) and I’m curious to receive feedback and suggestions. The main features are:

- Python 3.9 and type hints checked using mypy;
- Enforce QA checks using git hooks;
- Require full code coverage using unit tests and generate test payloads;
- Build documentation using Sphinx;
- Automatic versioning, publishing to PyPI, Changelog management using conventional commit messages and Github Actions

Currently the template still uses `pip` although I’m thinking to switch to `poetry`. Please feel free to discuss here, or to open issues in the [Github repository](https://github.com/jenstroeger/python-package-template).

Thank you so much in advance for your thoughts 🤓  
Jens

---

<div class="post-metadata">

**Author:** ![fungi](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/fungi/32/5963_2.png) [@fungi](https://discuss.python.org/u/fungi)\
**Post date:** [October 4, 2021, 9:40pm UTC](https://discuss.python.org/t/best-engineering-practices-for-a-python-package-seeking-feedback/10956/2 "2021-10-04T21:40:16Z")

</div>

[…]

> Github Actions  
> […]

I don’t know that I would consider “Github Actions” specifically a  
“best engineering practice” but perhaps you meant that as a stand-in  
for “CI system configuration” (which I agree is a good idea  
regardless of which code hosting platform you choose).

---

<div class="post-metadata">

**Author:** ![jens](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/jens/32/5052_2.png) [@jens](https://discuss.python.org/u/jens)\
**Post date:** [October 4, 2021, 9:56pm UTC](https://discuss.python.org/t/best-engineering-practices-for-a-python-package-seeking-feedback/10956/3 "2021-10-04T21:56:33Z")

</div>

@fungi — yes, what you said. Having this hosted on Github makes Actions a sensible approach to CI, but somebody may want to use Jenkins or CircleCI or Travis or whatever else.

Perhaps I should add a section & explanation to the README?
