Metadata-Version: 2.1
Name: jaraco.packaging
Version: 8.1.0
Summary: tools to supplement packaging Python releases
Home-page: https://github.com/jaraco/jaraco.packaging
Author: Jason R. Coombs
Author-email: jaraco@jaraco.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: Sphinx :: Extension
Requires-Python: >=3.6
Provides-Extra: docs
Provides-Extra: testing
License-File: LICENSE

.. image:: https://img.shields.io/pypi/v/jaraco.packaging.svg
   :target: `PyPI link`_

.. image:: https://img.shields.io/pypi/pyversions/jaraco.packaging.svg
   :target: `PyPI link`_

.. _PyPI link: https://pypi.org/project/jaraco.packaging

.. image:: https://dev.azure.com/jaraco/jaraco.packaging/_apis/build/status/jaraco.jaraco.packaging?branchName=master
   :target: https://dev.azure.com/jaraco/jaraco.packaging/_build/latest?definitionId=1&branchName=master

.. image:: https://img.shields.io/travis/jaraco/jaraco.packaging/master.svg
   :target: https://travis-ci.org/jaraco/jaraco.packaging

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Code style: Black

.. .. image:: https://img.shields.io/appveyor/ci/jaraco/jaraco-packaging/master.svg
..    :target: https://ci.appveyor.com/project/jaraco/jaraco-packaging/branch/master

.. image:: https://readthedocs.org/projects/jaracopackaging/badge/?version=latest
   :target: https://jaracopackaging.readthedocs.io/en/latest/?badge=latest

Tools for packaging.

dependency_tree
===============

A distutils command for reporting the dependency tree as resolved
by setuptools. Use after installing a package.

show
====

A distutils command for reporting the attributes of a distribution,
such as the version or author name. Here are some examples against
this package::

    $ python -q setup.py show
    jaraco.packaging 2.8.2.dev1+nfaae9fb96b36.d20151127
    $ python -q setup.py show --attributes version
    2.8.2.dev1+nfaae9fb96b36.d20151127
    $ python -q setup.py show --attributes author,author_email
    "Jason R. Coombs" jaraco@jaraco.com
    $ python setup.py -q show --attributes classifiers
    "['Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3']"
    $ python setup.py -q show --attributes "description url"
    "tools to supplement packaging Python releases" https://bitbucket.org/jaraco/jaraco.packaging

Note that passing -q suppresses the "running show" message.

Attributes may be specified as comma-separated or space-separated keys.
Results are printed using ``subprocess.list2cmdline`` so may be parsed using
``shlex.split``. By default, 'name' and 'version' are printed.

sphinx
======

This package provides a Sphinx extension that will inject into the config
the following values from the project's package metadata (as presented by
distutils):

 - project (from name)
 - author
 - copyright (same as author)
 - version
 - release (same as version)
 - package_url (from url)

To enable, include 'jaraco.packaging' in your requirements and add
'jaraco.packaging.sphinx' to your list of extensions in your config file::

    extensions=['jaraco.packaging.sphinx']

make-tree
=========

A utility for taking output from ``pipdeptree --json`` and producing a tree
rooted at a given package.

Usage::

    pipdeptree --json | python -m jaraco.packaging.make-tree mypkg


