Quick start

$ check-manifest -u -v
listing source files under version control: 6 files and directories
building an sdist: check-manifest-0.7.tar.gz: 4 files and directories
lists of files in version control and sdist do not match!
missing from sdist:
tests.py
tox.ini
suggested MANIFEST.in rules:
include *.py
include tox.ini
updating MANIFEST.in
$ cat MANIFEST.in
include *.rst
# added by check_manifest.py
include *.py
include tox.ini

Configuration

You can tell check-manifest to ignore certain file patterns by adding a
check-manifest section to your package’s setup.cfg. Example:

[check-manifest]
ignore =
.travis.yml

The following options are recognized:

ignore

A list of newline separated filename patterns that will be ignored by
check-manifest. Use this if you want to keep files in your version
control system that shouldn’t be included in your source distributions.
The default ignore list is

If set to true, your ignore patterns will replace the default
ignore list instead of adding to it.

ignore-bad-ideas

A list of newline separated filename patterns that will be ignored by
check-manifest’s generated files check. Use this if you want to keep
generated files in your version control system, even though it is generally
a bad idea.

Changelog

0.37 (2018-04-12)

Note that setuptools_scm usually makes MANIFEST.in files obsolete.
Having one is helpful only if you intend to build an sdist and then use that
sdist to perform further builds, instead of building from a source checkout.

0.26 (2015-10-30)

Drop Python 2.6 support because one of our test dependencies (mock) dropped
it. This also means we no longer use environment markers.

0.25 (2015-05-27)

Stop dynamic computation of install_requires in setup.py: this doesn’t work
well in the presence of the pip 7 wheel cache. Use PEP-426 environment
markers instead (this means we now require setuptools >= 0.7, and pip >= 6.0,
and wheel >= 0.24).

0.24 (2015-03-26)

Make sure setup.py not being added to the VCS doesn’t cause
hard-to-understand errors (issue #46).