Metadata-Version: 2.1
Name: tikzify
Version: 0.7
Summary: A set of utilities for programmatically generating TikZ code
Home-page: UNKNOWN
Author: Neil Girdhar
Author-email: mistersheik@gmail.com
License: UNKNOWN
Download-URL: https://pypi.python.org/pypi/tikzify
Project-URL: Bug Tracker, https://github.com/NeilGirdhar/tikzify/issues
Project-URL: Source Code, https://github.com/NeilGirdhar/tikzify
Keywords: testing,logging,example
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
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
Requires-Python: >=3.7
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 -rc -y`
  - :bash:`autopep8 -r -i .`
  - :bash:`pylint *`
  - :bash:`flake8 .`

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


