ricardolsmendes / python-package-cheat-sheet

Companion repository for the "A Python Package Developer’s Cheat Sheet" blog post

python-package-cheat-sheet

Notes & thoughts on clean Python package design.

Get to know the concepts behind this code

A Python Package Developer’s Cheat Sheet @ Better Programming / Medium

• Polish version, translated by Paulina Wyszyńska-Górecka

Core files

• setup.py: the package’s descriptor file, consists of a Python script where multiple properties can be set declaratively. Properties declared in this file are recognized by package managers such as pip and IDEs such as PyCharm, which means this is a must-have for any package.

• setup.cfg: used to customize setup scripts, such as setting pytest as the default runner for python setup.py test command.

• .coveragerc: controls the coverage script scope. This is pretty useful when you have folders in your project that don’t need to be monitored by the tool. In the proposed clean structure, only the src folder needs to be covered.

How to contribute

Please make sure to take a moment and read the Code of Conduct.

Report issues

Please report bugs and suggest features via the GitHub Issues.

Before opening an issue, search the tracker for possible duplicates. If you find a duplicate, please add a comment saying that you encountered the problem as well.

Contribute code

Please make sure to read the Contributing Guide before making a pull request.