Metadata-Version: 2.4
Name: tikzify
Version: 2.0.0
Summary: Utilities for programmatically generating TikZ code.
Project-URL: source, https://github.com/NeilGirdhar/tikzify
Author: Neil Girdhar
Author-email: mistersheik@gmail.com
Maintainer: Neil Girdhar
Maintainer-email: mistersheik@gmail.com
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: <3.14,>=3.11
Requires-Dist: more-itertools>=10
Requires-Dist: networkx>=3.1
Requires-Dist: numpy>=1.25
Requires-Dist: rectangle>=0.5.1
Requires-Dist: scipy-stubs>=1.15
Requires-Dist: scipy>=1.11
Description-Content-Type: text/x-rst

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

.. role:: python(code)
    :language: python

.. image:: https://img.shields.io/pypi/v/tikzify
   :target: https://pypi.org/project/tikzify/
   :alt: PyPI - Version
   :align: center
.. image:: https://img.shields.io/badge/version_scheme-EffVer-0097a7
   :alt: EffVer Versioning
   :target: https://jacobtomlinson.dev/effver
.. image:: https://img.shields.io/pypi/pyversions/tikzify
   :alt: PyPI - Python Version
   :align: center

=======
Tikzify
=======

A set of utilities for programmatically generating Typst code.

Previously: Tikz/Latex code; now, Typst.  This is a work in progress.

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

The implementation should be consistent with the surrounding style, be type annotated, and pass the
linters below.

There are a few tools to clean and check the source:

- :bash:`ruff check`
- :bash:`pyright`
- :bash:`mypy`
- :bash:`isort .`
- :bash:`pylint tikzify`

Running
=======

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

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

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

- Neil Girdhar
