diff options
author | Tarek Ziadé <ziade.tarek@gmail.com> | 2009-04-11 14:55:07 (GMT) |
---|---|---|
committer | Tarek Ziadé <ziade.tarek@gmail.com> | 2009-04-11 14:55:07 (GMT) |
commit | 942825f7de2b27dce73dccd4cd827dd86f409bba (patch) | |
tree | d2061d27f9a93c5a7b9228ee9a3f9575ce5337e1 /Doc/distutils/examples.rst | |
parent | b2daff2905c97ee74d4563095da5bcbb7c72524f (diff) | |
download | cpython-942825f7de2b27dce73dccd4cd827dd86f409bba.zip cpython-942825f7de2b27dce73dccd4cd827dd86f409bba.tar.gz cpython-942825f7de2b27dce73dccd4cd827dd86f409bba.tar.bz2 |
#5732: added the check command into Distutils
Diffstat (limited to 'Doc/distutils/examples.rst')
-rw-r--r-- | Doc/distutils/examples.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst index b495928..d5918a5 100644 --- a/Doc/distutils/examples.rst +++ b/Doc/distutils/examples.rst @@ -233,6 +233,58 @@ With exactly the same source tree layout, this extension can be put in the ext_modules=[Extension('foopkg.foo', ['foo.c'])], ) +Checking a package +================== + +The ``check`` command allows you to verify if your package meta-data are +meeting the minimum requirements to build a distribution. + +To run it, just call it over your :file:`setup.py` script. If something is +missing, ``check`` will display a warning. + +Let's take an example with a simple script:: + + from distutils.core import setup + + setup(name='foobar') + +Running the ``check`` command will display some warnings:: + + $ python setup.py check + running check + warning: check: missing required meta-data: version ,url + warning: check: missing meta-data: either (author and author_email) or + (maintainer and maintainer_email) must be supplied + + +If you use the reStructuredText syntax in the `long_description` field and +`docutils <http://docutils.sourceforge.net/>`_ is installed you can check if +the syntax is fine with the ``check`` command, using the `restructuredtext` +option. + +For example, if the :file:`setup.py` script is changed like this:: + + from distutils.core import setup + + desc = """\ + My description + ============= + + This is the description of the ``foobar`` package. + """ + + setup(name='foobar', version='1', author='tarek', + author_email='tarek@ziade.org', + url='http://example.com', long_description=desc) + +Where the long description is broken, ``check`` will be able to detect it +by using the `docutils` parser:: + + $ pythontrunk setup.py check --restructuredtext + running check + warning: check: Title underline too short. (line 2) + warning: check: Could not finish the parsing. + .. % \section{Multiple extension modules} .. % \label{multiple-ext} |