CHECK-MANIFEST(1)

💖 check-manifest(1) 💖

okay bestie, sit down, we're doing manpage time — this one lives in the General Commands Manual, so you know it's legit.

✨ NAME ✨

check-manifest — check a Python MANIFEST.in file for completeness 🦋

🌸 SYNOPSIS 🌸

check-manifest [OPTION...] [SOURCE TREE]

🎀 DESCRIPTION 🎀

So check-manifest does a vibe check on the MANIFEST.in file of a Python project and verifies its completeness. That's the whole job. It's giving quality control. 💅

It can also manifest a MANIFEST.in file out of thin air (from scratch, bestie, from nothing), or append suggestions to the one you already have. And if some patterns are just not the moment, you can ignore them. No pressure. 🫶

👑 OPTIONS 👑

• -h, --help — show a summary of options. iconic behaviour honestly.
• --version — show the version of the program. 🏷️
• -v, --verbose — more verbose output (default: False). turn the volume UP.
• -c, --create — create a MANIFEST.in if it's missing (default: False). 💫
• -u, --update — append suggestions to MANIFEST.in (this implies --create) (default: False). not me adding suggestions unprompted, but actually yes, me.
• -p PYTHON, --python PYTHON — use the specified PYTHON interpreter when running setup.py sdist (default: sys.executable). pick your fighter. 🐍
• --ignore PATTERNS — ignore files/directories matching PATTERNS, which is a comma-separated list of patterns (default: None). 🚫
• --ignore-bad-ideas PATTERNS — ignore bad idea files/directories matching PATTERNS, comma-separated (default: []). you can keep your problematic faves, we're not the police. 💀

⚙️ CONFIGURATION ⚙️

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

[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

PKG-INFO
*.egg-info
*.egg-info/*
setup.cfg
\.hgtags
\.hgsigs
\.hgignore
\.gitignore
\.bzrignore
\.gitattributes
\.travis.yml
Jenkinsfile
*.mo

ignore-default-rules

If set to true, your ignore patterns will replace the default ignore list instead of adding to it. glow up, old rules, you're done here. ✨

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. 🙈 we said what we said.

😭 REPORTING BUGS 😭

Please report bugs using the Debian BTS <https://bugs.debian.org>.

not me asking you nicely to file a bug. the BTS is right there bestie. go off. 🫶

💜 AUTHOR 💜

check-manifest is copyright (C) 2013 Marius Gedminas and contributors.

This manual page was written by Sergio Durigan Junior <sergiodj@sergiodj.net> based on the project's README.rst for the Debian GNU/Linux system, but may be used by others.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

and that's the whole page, bestie. it's dated December 28 2017, and it came to you straight from the General Commands Manual (the CHECK-MANIFEST(1) energy, you know how it is). mwah 💅✨💖