sdist_check

setuptools sdist checker.


Keywords
setuptools, sdist, check
License
MIT
Install
pip install sdist_check==0.1

Documentation

sdist_check (discontinued)

bdg-build | sources | issues

Warning

This project is not active any more. There will not be any further release. The github repository of sdist_check will be deleted on Dec 1st, 2016.

Please use Marius Gedminas' awesome check-manifest instead. It's more mature, provides better and more powerful scans and is already used by a lot of smart people.

I would not have started this project, if I had known Marius` excellent tool (thank you Marius!) at that time. So go and use it. sdist-check is now gone. Gone to meet its maker.

setuptools plugin providing a new command sdist_check. It is run like any other regular setuptools command:

$ python setup.py sdist_check
running sdist_check

and does some additional checks compared to the setuptools built-in command check. For instance it scans distributions built with sdist for files you most probably do not want to be part of the distribution.

A list of all supported options of the sdist_check command can be retrieved like this:

$ python setup.py sdist_check --help
Common commands: (see '--help-commands' for more)

  setup.py build      will build the package underneath 'build/'
  setup.py install    will install the package

  ...

Options for 'sdist_check' command:
  --metadata (-m)          Verify meta-data
  --restructuredtext (-r)  Checks if long string meta-data syntax are
                           reStructuredText-compliant
  --strict (-s)            Will exit with an error if a check fails
  --badfiles (-b)          Check files included in dist for unusual names

...

The badfiles option is a list of filename patterns which are considered as non-wanted in distributions. By default, we look for files named like "*~".