The **pkginfo** utility
=======================

Extracts package metadata from Python ``setup`` scripts.

All operations are performed on ``setup.py`` in the current directory unless
:option:`-f` is specified.

Usage
-----

:samp:`pkginfo.py [{options}] {format}[, {format}, ...]`

Options
-------

.. Three classes of options are provided: generic, modal, and specific.
.. 
.. Generic options may be used alone or with any other option.
.. 
.. Modal options are mutually exclusive as each causes **pkginfo.py** to exit
.. immediately after performing its task.
.. 
.. Specific options are only applicable when given with particular modal options.
.. 
.. ============== ======== ====
.. Option         Type     Mode
.. ============== ======== ====
.. :option:`-f`   Generic  
.. :option:`-h`   Modal    Help
.. :option:`-l`   Modal    List keys
.. :option:`-V`   Modal    Version
.. :option:`-t`   Specific List keys
.. :option:`-v`   Specific List keys
.. ============== ======== ====

Specifying `FILE`
+++++++++++++++++

.. option:: -f <FILE>, --file <FILE>

   Specify a setup `FILE` to use instead of ``setup.py``.

Miscellaneous
+++++++++++++
   
.. option:: -h, --help
   
   Show a help message and exit.

.. option:: -l, --list-keys
   
   List available metadata keys in `FILE` and exit.

.. option:: -V, --version
   
   Show program's version number and exit.

Formatting metadata
-------------------

:samp:`pkginfo.py [-f {FILE}] {format}`

Example output::

   Annabel:base ryan$ pkginfo.py 'dist/{name}-{version}.tar.gz'
   dist/draxoft.base-0.1.tar.gz

Listing metadata keys
---------------------

:samp:`pkginfo.py [-f {FILE}|{specific options}] -l`
   
Example output::

   Annabel:base ryan$ bin/pkginfo.py -lt
   Available metadata keys:
    * author (str)
    * author_email (str)
    * classifiers (list)
    * cmdclass (dict)
    * description (str)
    * download_url (str)
    * long_description (str)
    * name (str)
    * package_dir (dict)
    * packages (list)
    * provides (list)
    * scripts (list)
    * url (str)
    * version (str)

Specific options
++++++++++++++++

.. option:: -t, --show-types
   
   Show types when listing available metadata keys.

.. option:: -v, --show-values
   
   Show values when listing available metadata keys.