Metadata-Version: 2.1
Name: pyfactor
Version: 0.4.1
Summary: A script dependency visualiser.
Home-page: https://pyfactor.rtfd.org
Author: Felix Hildén
Author-email: felix.hilden@gmail.com
Maintainer: Felix Hildén
Maintainer-email: felix.hilden@gmail.com
License: MIT
Download-URL: https://pypi.org/project/pyfactor
Project-URL: Source, https://github.com/felix-hilden/pyfactor
Project-URL: Issues, https://github.com/felix-hilden/pyfactor/issues
Project-URL: Documentation, https://pyfactor.rtfd.org
Keywords: dependency visualiser
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: pydot
Requires-Dist: networkx
Requires-Dist: graphviz
Requires-Dist: dataclasses ; python_version < "3.7"
Provides-Extra: checks
Requires-Dist: tox ; extra == 'checks'
Requires-Dist: doc8 ; extra == 'checks'
Requires-Dist: flake8 ; extra == 'checks'
Requires-Dist: flake8-bugbear ; extra == 'checks'
Requires-Dist: pydocstyle ; extra == 'checks'
Requires-Dist: pygments ; extra == 'checks'
Provides-Extra: dev
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'dev'
Requires-Dist: sphinx-argparse ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: doc8 ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: flake8-bugbear ; extra == 'dev'
Requires-Dist: pydocstyle ; extra == 'dev'
Requires-Dist: pygments ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Requires-Dist: sphinx-argparse ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: coverage ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'

========
Pyfactor
========
|python|

Welcome to the PyPI page of *Pyfactor*
- a refactoring tool that `visualises <rtd-gallery_>`_
Python source files, modules and importable packages as a graph of dependencies
between Python constructs like variables, functions and classes.

.. code:: sh

    $ pyfactor --help
    $ pyfactor script.py
    $ pyfactor script.py --skip-external --view

Visit our online documentation on `Read The Docs`_
for reference documentation, examples and release notes.
If you've found a bug or would like to propose a feature,
please submit an issue on `GitHub`_.

Installation
============
*Pyfactor* can be installed from the Package Index via ``pip``.

.. code:: sh

    $ pip install pyfactor

**Additionally**, *Pyfactor* depends on a free graph visualisation software
`Graphviz <https://graphviz.org/>`_, available for Linux, Windows and Mac.
See also the documentation of the `Graphviz Python package
<https://graphviz.readthedocs.io/en/stable/#installation>`_ for more help.

Release notes
=============
Release notes can be found on our
`Read The Docs site <https://pyfactor.rtfd.org/page/release-notes.html>`_.

.. |python| image:: https://img.shields.io/pypi/pyversions/pyfactor
   :alt: python version

.. _read the docs: https://pyfactor.rtfd.org
.. _rtd-gallery: https://pyfactor.rtfd.org/en/stable/gallery.html
.. _github: https://github.com/felix-hilden/pyfactor


