Tool to check the completeness of for Python packages
Go to file
Marius Gedminas ecbdd85e28 Preparing release 0.46 2021-01-04 16:35:08 +02:00
.github Simplify coveralls integration 2020-12-06 19:09:13 +02:00
.coveragerc Refactor UI code to avoid global state 2020-05-02 20:12:31 +03:00
.gitignore Rewrite the IgnoreList logic to be more distutils-like 2020-05-03 15:38:08 +03:00
.pre-commit-hooks.yaml Add 'language_version: python3' to .pre-commit-hooks.yaml 2020-12-20 16:48:01 -08:00
CHANGES.rst Preparing release 0.46 2021-01-04 16:35:08 +02:00
LICENSE.rst Rename LICENCE to LICENSE 2016-09-22 11:34:34 +03:00 Remove unused .travis.yml 2020-12-20 16:25:52 -08:00
Makefile Automate the version update in the README 2020-11-30 08:53:41 +02:00
README.rst Preparing release 0.46 2021-01-04 16:35:08 +02:00
appveyor.yml Add Python 3.9 support 2020-10-27 11:33:31 +02:00 Preparing release 0.46 2021-01-04 16:35:08 +02:00 Cleaned up makefile, added 'make help', newer 2020-10-11 14:02:38 +03:00
setup.cfg Remove "universal" from bdist_wheel configuration 2020-12-21 06:38:49 -08:00 Merge pull request #135 from jdufresne/py3-only 2020-12-21 13:03:30 +02:00 Merge pull request #136 from jdufresne/pyupgrade 2020-12-21 13:07:13 +02:00
tox.ini Replace use of nose with pytest 2020-12-20 16:37:12 -08:00



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 configure check-manifest to ignore certain file patterns using a [tool.check-manifest] section in your pyproject.toml file or a [check-manifest] section in either setup.cfg or tox.ini. Examples:

# pyproject.toml
ignore = [".travis.yml"]

# setup.cfg or tox.ini
ignore =

Note that lists are newline separated in the setup.cfg and tox.ini files.

The following options are recognized:


A list of 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 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.

Version control integration

With pre-commit, check-manifest can be part of your git-workflow. Add the following to your .pre-commit-config.yaml.

-   repo:
    rev: "0.46"
    -   id: check-manifest

If you are running pre-commit without a network, you can utilize args: [--no-build-isolation] to prevent a pip install reaching out to pypi. If you have additional build-system.requires outside of pip / setuptools / wheel you will want to list those in additional_dependencies.

-   repo:
    rev: ...  # pick a valid tag / revision
    -   id: check-manifest
        args: [--no-build-isolation]
        additional_dependencies: [setuptools-scm]