Metadata-Version: 2.1
Name: impulse
Version: 1.0b2
Summary: Command line interface for analyzing Python imports.
Home-page: UNKNOWN
Author: David Seddon
Author-email: david@seddonym.me
License: BSD 2-Clause License
Project-URL: Source code, https://github.com/seddonym/impulse/
Description: =======
        Impulse
        =======
        
        .. image:: https://img.shields.io/pypi/v/impulse.svg
            :target: https://pypi.org/project/impulse
        
        .. image:: https://img.shields.io/pypi/pyversions/impulse.svg
            :alt: Python versions
            :target: https://pypi.org/project/impulse/
        
        .. image:: https://api.travis-ci.org/seddonym/impulse.svg?branch=master
            :target: https://travis-ci.org/seddonym/impulse
        
        * Free software: BSD license
        
        Impulse is a command line tool for exploring the imports in a Python package.
        
        It can be used to produce dependency graphs such as this:
        
        .. image:: https://raw.githubusercontent.com/seddonym/impulse/master/docs/_static/images/flask.png
          :align: center
          :alt: Graph of flask package.
        
        **Warning:** This software is currently in beta. It is undergoing active development, and breaking changes may be
        introduced between versions.
        
        Installation
        ------------
        
        Install Graphviz
        ****************
        
        First, you will need to install Graphviz. For more information, see the
        `Graphviz download page`_ or search for "how to install Graphviz" on your operating system.
        
        
        .. _Graphviz download page: https://www.graphviz.org/download/
        
        Install Impulse
        ***************
        
        ::
        
            pip install impulse
        
        Install the Python package you wish to analyse
        **********************************************
        
        ::
        
            pip install somepackage
        
        Command overview
        ----------------
        
        There is currently only one command, feel free to suggest more by opening an issue or pull request.
        
        ``drawgraph``
        *************
        
        Draw a graph of the dependencies within any installed Python package or subpackage.
        
        The graph shows the relationship between all the immediate children of the package. An arrow indicates that there is
        at least one import by the child (or any of its descendants) from the subpackage where the arrow points.
        
        For example, in a graph of the package ``django.db``, there is an arrow from ``django.db.backends`` pointing to
        ``django.db.models``.  This is because ``django.db.backends.base.schema`` imports ``django.db.models.Index``. All
        descendants are treated as belonging to the child they are in, so an import between any of those descendants will
        cause an import to be shown.
        
        **Command**::
        
            impulse drawgraph django.db
        
        **Output:**
        
        .. image:: https://raw.githubusercontent.com/seddonym/impulse/master/docs/_static/images/django.db.png
          :align: center
          :alt: Graph of django.db package.
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst
