?HAMA

Edit File Size: 3.11 KB

/opt/alt/python37/share/doc/alt-python37-setuptools/docs/build_meta.rst

Text Base64

=======================================
Build System Support
=======================================

What is it?
-------------

Python packaging has come `a long way <https://bernat.tech/posts/pep-517-518/>`_.

The traditional ``setuptools`` way of packaging Python modules
uses a ``setup()`` function within the ``setup.py`` script. Commands such as
``python setup.py bdist`` or ``python setup.py bdist_wheel`` generate a 
distribution bundle and ``python setup.py install`` installs the distribution. 
This interface makes it difficult to choose other packaging tools without an 
overhaul. Because ``setup.py`` scripts allowed for arbitrary execution, it
proved difficult to provide a reliable user experience across environments
and history.

`PEP 517 <https://www.python.org/dev/peps/pep-0517/>`_ therefore came to
rescue and specified a new standard to 
package and distribute Python modules. Under PEP 517:

a ``pyproject.toml`` file is used to specify what program to use
    for generating distribution.

Then, two functions provided by the program, ``build_wheel(directory: str)`` 
    and ``build_sdist(directory: str)`` create the distribution bundle at the 
    specified ``directory``. The program is free to use its own configuration 
    script or extend the ``.toml`` file.

Lastly, ``pip install *.whl`` or ``pip install *.tar.gz`` does the actual
    installation. If ``*.whl`` is available, ``pip`` will go ahead and copy
    the files into ``site-packages`` directory. If not, ``pip`` will look at
    ``pyproject.toml`` and decide what program to use to 'build from source' 
    (the default is ``setuptools``)

With this standard, switching between packaging tools becomes a lot easier. ``build_meta``
implements ``setuptools``' build system support.

How to use it?
--------------

Starting with a package that you want to distribute. You will need your source
scripts, a ``pyproject.toml`` file and a ``setup.cfg`` file::

~/meowpkg/
        pyproject.toml
        setup.cfg
        meowpkg/__init__.py

The pyproject.toml file is required to specify the build system (i.e. what is 
being used to package your scripts and install from source). To use it with 
setuptools, the content would be::

[build-system]
    requires = ["setuptools", "wheel"]
    build-backend = "setuptools.build_meta"

The ``setuptools`` package implements the ``build_sdist``
command and the ``wheel`` package implements the ``build_wheel``
command; both are required to be compliant with PEP 517.

Use ``setuptools``' :ref:`declarative config <declarative config>` to
specify the package information::

[metadata]
    name = meowpkg
    version = 0.0.1
    description = a package that meows
    
    [options]
    packages = find:

Now generate the distribution. To build the package, use
`PyPA build <https://pypa-build.readthedocs.io/en/latest/>`_::

$ pip install -q build
    $ python -m build

And now it's done! The ``.whl`` file  and ``.tar.gz`` can then be distributed 
and installed::

dist/
        meowpkg-0.0.1.whl
        meowpkg-0.0.1.tar.gz

$ pip install dist/meowpkg-0.0.1.whl

or::

$ pip install dist/meowpkg-0.0.1.tar.gz

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
deprecated DIR	-	drwxr-xr-x	2024-03-03 22:40:05	Edit Download recursive recursive
development DIR	-	drwxr-xr-x	2024-03-03 22:40:05	Edit Download recursive recursive
references DIR	-	drwxr-xr-x	2024-03-03 22:40:05	Edit Download recursive recursive
userguide DIR	-	drwxr-xr-x	2024-03-03 22:40:05	Edit Download recursive recursive
build_meta.rst	3.11 KB	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
conf.py	5.58 KB	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
history.rst	1.86 KB	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
index.rst	461 B	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
pkg_resources.rst	92.11 KB	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
python 2 sunset.rst	3.46 KB	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
roadmap.rst	161 B	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive
setuptools.rst	6.21 KB	lrw-r--r--	2021-10-22 20:55:51	Edit Download recursive recursive

Directory Contents