Tool to check the completeness of for Python packages
Python Makefile
Latest commit 5811039 Feb 24, 2017 @tjanez tjanez committed with Add Jenkinsfile to IGNORE list (#81)



buildstatus appveyor coverage

Are you a Python developer? Have you uploaded packages to the Python Package Index? Have you accidentally uploaded broken packages with some files missing? If so, check-manifest is for you.

Quick start

$ pip install check-manifest

$ cd ~/src/mygreatpackage
$ check-manifest

You can ask the script to help you update your

$ 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:
suggested rules:
  include *.py
  include tox.ini

$ cat
include *.rst

# added by
include *.py
include tox.ini

Command-line reference

$ check-manifest --help
usage: check-manifest [-h] [--version] [-v] [-c] [-u] [-p PYTHON]
                      [--ignore patterns]

Check a Python file for completeness

positional arguments:
  source_tree           location for the source tree (default: .)

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         more verbose output (default: False)
  -c, --create          create a if missing (default: False)
  -u, --update          append suggestions to (implies --create)
                        (default: False)
  -p PYTHON, --python PYTHON
                        use this Python interpreter for running sdist
                        (default: /home/mg/.venv/bin/python)
  --ignore patterns     ignore files/directories matching these comma-
                        separated patterns (default: None)
  --ignore-bad-ideas patterns
                        ignore bad idea files/directories matching these
                        comma-separated patterns (default: [])


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

ignore =

The following options are recognized:


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.
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.