How to build a source distribution without using setup.py file?
There's nothing "obvious" when it comes to Python packaging. Indeed, for the time being, at least if you are using distutils/setuptools it is necessary to create a (nearly) empty setup.py
file, even if you are using a fully declarative setup.cfg
:
#!/usr/bin/env python
from setuptools import setup
setup()
I also recommend chmod +x setup.py
.
In this case you are just writing the "entry point" to the build system yourself, and setup()
is just the main()
function for it--but now all the arguments that were traditionally passed to setup()
can be read from setup.cfg
instead.
Now you can still use setup.py sdist
if you want to make a source tarball:
./setup.py sdist
You could also try one of the alternative build systems that are enabled via pyproject.toml
, such as Flit.
This is a somewhat controversial topic, and the answer for the moment is that there is no one single tool that everyone agrees is the "right way" to build source distributions, nor what that tool would be. You can see a long thread about it on the Python Packaging discourse.
I hesitate to give too much packaging advice in durable formats because the sands are always shifting, but as of November 2019, setup.py sdist
is not deprecated, but it does have all the downsides that PEP 517 and PEP 518 were intended to fix - namely that you have to create the build environment yourself (and know about all the build dependencies), and it only works with setuptools/distutils and their equivalents.
It is not an "official" recommendation, but the current (Dec. 2020) best replacement for setup.py sdist
and setup.py bdist_wheel
is using pypa-build. Install once with
pip install build
and use as
python -m build --sdist --wheel
This builds source distribution and wheel at the same time. This is how I build my PEP 517-compatible packages.
This requires that your project have a pyproject.toml
, and the pyproject.toml
must have build-system.requires
and build-system.build-backend
keys, but it will work for any project with a PEP 517-compatible backend (including flit
).
Other tools
Why not use flit
or poetry
or hatch
? Those tools are all available for those who want to use them, but they are not an answer to this question. This question is asking about projects build with setuptools
that use the declarative setup.cfg
format. Neither flit
nor poetry
act as generic PEP 517 build front-ends, and so they only work as build commands for projects using their respective backends.
I am not familiar enough with hatch
to say whether or not it can manage projects with backends other than setuptools, but (again, as of November 2019), it is not a PEP 517 frontend, and it will not work if you don't have a setup.py
(it will raise the error "can't open file setup.py", and it will ignore your pyproject.toml
file).
If you don't want to install a 3rd party tool and dont want to create a temporary setup.py
, you also could use
python -c "import setuptools; setuptools.setup()" sdist