271 lines
12 KiB
ReStructuredText
271 lines
12 KiB
ReStructuredText
.. _source-dist:
|
|
|
|
******************************
|
|
Creating a Source Distribution
|
|
******************************
|
|
|
|
As shown in section :ref:`distutils-simple-example`, you use the :command:`sdist` command
|
|
to create a source distribution. In the simplest case, ::
|
|
|
|
python setup.py sdist
|
|
|
|
(assuming you haven't specified any :command:`sdist` options in the setup script
|
|
or config file), :command:`sdist` creates the archive of the default format for
|
|
the current platform. The default format is a gzip'ed tar file
|
|
(:file:`.tar.gz`) on Unix, and ZIP file on Windows.
|
|
|
|
You can specify as many formats as you like using the :option:`--formats`
|
|
option, for example::
|
|
|
|
python setup.py sdist --formats=gztar,zip
|
|
|
|
to create a gzipped tarball and a zip file. The available formats are:
|
|
|
|
+-----------+-------------------------+---------+
|
|
| Format | Description | Notes |
|
|
+===========+=========================+=========+
|
|
| ``zip`` | zip file (:file:`.zip`) | (1),(3) |
|
|
+-----------+-------------------------+---------+
|
|
| ``gztar`` | gzip'ed tar file | \(2) |
|
|
| | (:file:`.tar.gz`) | |
|
|
+-----------+-------------------------+---------+
|
|
| ``bztar`` | bzip2'ed tar file | |
|
|
| | (:file:`.tar.bz2`) | |
|
|
+-----------+-------------------------+---------+
|
|
| ``ztar`` | compressed tar file | \(4) |
|
|
| | (:file:`.tar.Z`) | |
|
|
+-----------+-------------------------+---------+
|
|
| ``tar`` | tar file (:file:`.tar`) | |
|
|
+-----------+-------------------------+---------+
|
|
|
|
Notes:
|
|
|
|
(1)
|
|
default on Windows
|
|
|
|
(2)
|
|
default on Unix
|
|
|
|
(3)
|
|
requires either external :program:`zip` utility or :mod:`zipfile` module (part
|
|
of the standard Python library since Python 1.6)
|
|
|
|
(4)
|
|
requires the :program:`compress` program. Notice that this format is now
|
|
pending for deprecation and will be removed in the future versions of Python.
|
|
|
|
When using any ``tar`` format (``gztar``, ``bztar``, ``ztar`` or
|
|
``tar``) under Unix, you can specify the ``owner`` and ``group`` names
|
|
that will be set for each member of the archive.
|
|
|
|
For example, if you want all files of the archive to be owned by root::
|
|
|
|
python setup.py sdist --owner=root --group=root
|
|
|
|
|
|
.. _manifest:
|
|
|
|
Specifying the files to distribute
|
|
==================================
|
|
|
|
If you don't supply an explicit list of files (or instructions on how to
|
|
generate one), the :command:`sdist` command puts a minimal default set into the
|
|
source distribution:
|
|
|
|
* all Python source files implied by the :option:`py_modules` and
|
|
:option:`packages` options
|
|
|
|
* all C source files mentioned in the :option:`ext_modules` or
|
|
:option:`libraries` options
|
|
|
|
.. XXX Getting C library sources is currently broken -- no
|
|
:meth:`get_source_files` method in :file:`build_clib.py`!
|
|
|
|
* scripts identified by the :option:`scripts` option
|
|
See :ref:`distutils-installing-scripts`.
|
|
|
|
* anything that looks like a test script: :file:`test/test\*.py` (currently, the
|
|
Distutils don't do anything with test scripts except include them in source
|
|
distributions, but in the future there will be a standard for testing Python
|
|
module distributions)
|
|
|
|
* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever you
|
|
called your setup script), and :file:`setup.cfg`
|
|
|
|
* all files that matches the ``package_data`` metadata.
|
|
See :ref:`distutils-installing-package-data`.
|
|
|
|
* all files that matches the ``data_files`` metadata.
|
|
See :ref:`distutils-additional-files`.
|
|
|
|
Sometimes this is enough, but usually you will want to specify additional files
|
|
to distribute. The typical way to do this is to write a *manifest template*,
|
|
called :file:`MANIFEST.in` by default. The manifest template is just a list of
|
|
instructions for how to generate your manifest file, :file:`MANIFEST`, which is
|
|
the exact list of files to include in your source distribution. The
|
|
:command:`sdist` command processes this template and generates a manifest based
|
|
on its instructions and what it finds in the filesystem.
|
|
|
|
If you prefer to roll your own manifest file, the format is simple: one filename
|
|
per line, regular files (or symlinks to them) only. If you do supply your own
|
|
:file:`MANIFEST`, you must specify everything: the default set of files
|
|
described above does not apply in this case.
|
|
|
|
See :ref:`manifest_template` section for a syntax reference.
|
|
|
|
.. _manifest-options:
|
|
|
|
Manifest-related options
|
|
========================
|
|
|
|
The normal course of operations for the :command:`sdist` command is as follows:
|
|
|
|
* if the manifest file, :file:`MANIFEST` doesn't exist, read :file:`MANIFEST.in`
|
|
and create the manifest
|
|
|
|
* if neither :file:`MANIFEST` nor :file:`MANIFEST.in` exist, create a manifest
|
|
with just the default file set
|
|
|
|
* if either :file:`MANIFEST.in` or the setup script (:file:`setup.py`) are more
|
|
recent than :file:`MANIFEST`, recreate :file:`MANIFEST` by reading
|
|
:file:`MANIFEST.in`
|
|
|
|
* use the list of files now in :file:`MANIFEST` (either just generated or read
|
|
in) to create the source distribution archive(s)
|
|
|
|
There are a couple of options that modify this behaviour. First, use the
|
|
:option:`--no-defaults` and :option:`--no-prune` to disable the standard
|
|
"include" and "exclude" sets.
|
|
|
|
Second, you might just want to (re)generate the manifest, but not create a
|
|
source distribution::
|
|
|
|
python setup.py sdist --manifest-only
|
|
|
|
:option:`-o` is a sortcut for :option:`--manifest-only`.
|
|
|
|
.. _manifest_template:
|
|
|
|
The MANIFEST.in template
|
|
========================
|
|
|
|
A :file:`MANIFEST.in` file can be added in a project to define the list of
|
|
files to include in the distribution built by the :command:`sdist` command.
|
|
|
|
When :command:`sdist` is run, it will look for the :file:`MANIFEST.in` file
|
|
and interpret it to generate the :file:`MANIFEST` file that contains the
|
|
list of files that will be included in the package.
|
|
|
|
This mechanism can be used when the default list of files is not enough.
|
|
(See :ref:`manifest`).
|
|
|
|
Principle
|
|
---------
|
|
|
|
The manifest template has one command per line, where each command specifies a
|
|
set of files to include or exclude from the source distribution. For an
|
|
example, let's look at the Distutils' own manifest template::
|
|
|
|
include *.txt
|
|
recursive-include examples *.txt *.py
|
|
prune examples/sample?/build
|
|
|
|
The meanings should be fairly clear: include all files in the distribution root
|
|
matching :file:`\*.txt`, all files anywhere under the :file:`examples` directory
|
|
matching :file:`\*.txt` or :file:`\*.py`, and exclude all directories matching
|
|
:file:`examples/sample?/build`. All of this is done *after* the standard
|
|
include set, so you can exclude files from the standard set with explicit
|
|
instructions in the manifest template. (Or, you can use the
|
|
:option:`--no-defaults` option to disable the standard set entirely.)
|
|
|
|
The order of commands in the manifest template matters: initially, we have the
|
|
list of default files as described above, and each command in the template adds
|
|
to or removes from that list of files. Once we have fully processed the
|
|
manifest template, we remove files that should not be included in the source
|
|
distribution:
|
|
|
|
* all files in the Distutils "build" tree (default :file:`build/`)
|
|
|
|
* all files in directories named :file:`RCS`, :file:`CVS`, :file:`.svn`,
|
|
:file:`.hg`, :file:`.git`, :file:`.bzr` or :file:`_darcs`
|
|
|
|
Now we have our complete list of files, which is written to the manifest for
|
|
future reference, and then used to build the source distribution archive(s).
|
|
|
|
You can disable the default set of included files with the
|
|
:option:`--no-defaults` option, and you can disable the standard exclude set
|
|
with :option:`--no-prune`.
|
|
|
|
Following the Distutils' own manifest template, let's trace how the
|
|
:command:`sdist` command builds the list of files to include in the Distutils
|
|
source distribution:
|
|
|
|
#. include all Python source files in the :file:`distutils` and
|
|
:file:`distutils/command` subdirectories (because packages corresponding to
|
|
those two directories were mentioned in the :option:`packages` option in the
|
|
setup script---see section :ref:`setup-script`)
|
|
|
|
#. include :file:`README.txt`, :file:`setup.py`, and :file:`setup.cfg` (standard
|
|
files)
|
|
|
|
#. include :file:`test/test\*.py` (standard files)
|
|
|
|
#. include :file:`\*.txt` in the distribution root (this will find
|
|
:file:`README.txt` a second time, but such redundancies are weeded out later)
|
|
|
|
#. include anything matching :file:`\*.txt` or :file:`\*.py` in the sub-tree
|
|
under :file:`examples`,
|
|
|
|
#. exclude all files in the sub-trees starting at directories matching
|
|
:file:`examples/sample?/build`\ ---this may exclude files included by the
|
|
previous two steps, so it's important that the ``prune`` command in the manifest
|
|
template comes after the ``recursive-include`` command
|
|
|
|
#. exclude the entire :file:`build` tree, and any :file:`RCS`, :file:`CVS`,
|
|
:file:`.svn`, :file:`.hg`, :file:`.git`, :file:`.bzr` and :file:`_darcs`
|
|
directories
|
|
|
|
Just like in the setup script, file and directory names in the manifest template
|
|
should always be slash-separated; the Distutils will take care of converting
|
|
them to the standard representation on your platform. That way, the manifest
|
|
template is portable across operating systems.
|
|
|
|
Commands
|
|
--------
|
|
|
|
The manifest template commands are:
|
|
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| Command | Description |
|
|
+===========================================+===============================================+
|
|
| :command:`include pat1 pat2 ...` | include all files matching any of the listed |
|
|
| | patterns |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`exclude pat1 pat2 ...` | exclude all files matching any of the listed |
|
|
| | patterns |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`recursive-include dir pat1 pat2 | include all files under *dir* matching any of |
|
|
| ...` | the listed patterns |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`recursive-exclude dir pat1 pat2 | exclude all files under *dir* matching any of |
|
|
| ...` | the listed patterns |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`global-include pat1 pat2 ...` | include all files anywhere in the source tree |
|
|
| | matching --- & any of the listed patterns |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`global-exclude pat1 pat2 ...` | exclude all files anywhere in the source tree |
|
|
| | matching --- & any of the listed patterns |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`prune dir` | exclude all files under *dir* |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
| :command:`graft dir` | include all files under *dir* |
|
|
+-------------------------------------------+-----------------------------------------------+
|
|
|
|
The patterns here are Unix-style "glob" patterns: ``*`` matches any sequence of
|
|
regular filename characters, ``?`` matches any single regular filename
|
|
character, and ``[range]`` matches any of the characters in *range* (e.g.,
|
|
``a-z``, ``a-zA-Z``, ``a-f0-9_.``). The definition of "regular filename
|
|
character" is platform-specific: on Unix it is anything except slash; on Windows
|
|
anything except backslash or colon.
|
|
|