A 'controversial' opinion
Using `setup.py` to pack and distribute your python packages can be quite challenging every so often. Tools like Poetry make not only the packaging a lot easier, but also help you to manage your dependencies in a very convenient way.
If you want more information about Poetry you can read the following articles:
- Python projects with Poetry and VSCode. Part 1
- Python projects with Poetry and VSCode. Part 2
- Python projects with Poetry and VSCode. Part 3
The setup script is the center of all activity in building, distributing, and installing modules using the Distutils. The main purpose of the setup script is to describe your module distribution to the Distutils, so that the various commands that operate on your modules do the right thing.
setup.py file is at the heart of a Python project. It describes all the metadata about your project. There are quite a few fields you can add to a project to give it a rich set of metadata describing the project. However, there are only three required fields: name, version, and packages. The name field must be unique if you wish to publish your package on the Python Package Index (PyPI). The version field keeps track of different releases of the project. The package’s field describes where you’ve put the Python source code within your project.
This allows you to easily install Python packages. Often it’s enough to write:
python setup.py install
and module will install itself.
Our initial setup.py will also include information about the license and will re-use the README.txt file for the long_description field. This will look like:
from distutils.core import setup setup( name='pythonCheatsheet', version='0.1', packages=['pipenv',], license='MIT', long_description=open('README.txt').read(), )
Find more information visit the official documentation.