Metadata-Version: 2.1
Name: tikzify
Version: 0.11.1
Summary: Utilities for programmatically generating TikZ code.
Home-page: https://github.com/NeilGirdhar/tikzify
License: MIT
Author: Neil Girdhar
Author-email: mistersheik@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: more_itertools (>=8,<9)
Requires-Dist: networkx (>=2.5,<3.0)
Requires-Dist: numpy (>=1.19,<2.0)
Requires-Dist: tjax (>=0.6)
Project-URL: Repository, https://github.com/NeilGirdhar/tikzify
Description-Content-Type: text/x-rst

=======
Tikzify
=======
.. image:: https://badge.fury.io/py/tikzify.svg
    :target: https://badge.fury.io/py/tikzify

.. role:: bash(code)
    :language: bash

A set of utilities for programmatically generating TikZ code.

Contribution guidelines
=======================

- Conventions

  - Naming conventions are according to PEP8.

- How to clean the source:

  - :bash:`isort .`
  - :bash:`pylint tikzify`
  - :bash:`flake8 tikzify`

Running
=======

- This macro is helpful for running examples:

.. code-block:: bash

    function dm {
        python "$1.py" $2 && pdflatex -shell-escape $1 && open $1.pdf
    }

- The basal ganglia example can be run by doing :bash:`dm basal_ganglia` from the examples folder.  It should produce :bash:`basal_ganglia.pdf`, which shows all of the output, as well as :bash:`figures/basal_ganglia-*.pdf`, which are the individual diagrams to be included.

- A copy of the `pdf <basal_ganglia.pdf>` is provided at the top level folder.  It shows three programmatically-generated diagrams, with various sections highlighted.

Whom do I talk to?
==================

- Neil Girdhar

