Giter Club home page Giter Club logo

pythontikz's Introduction

pythonTikZ Integration Latest Docs Coverage

pythonTikZ is a Python library creating TikZ graphics in LaTeX. The library began in concept as a fork of PyLaTeX, which still forms a basis for the package. Its goal is to provide a higher level interface, less error prone interface to writing TikZ, whilst still exposing enough low level detail that complex diagrams can be produced. Whilst most changes are in the form of additional functionality, some of the PyLaTeX base classes have been modified for a cleaner user experience.

The library aims to provide a convenient, reusable way of writing TikZ where documentation and type hinting are available to aid in this process.

Installation

pythonTikZ works on Python 3.6+ Currently it also will work on earlier versions of Python 3, but this is not a continuing commitment, use of f-strings are expected in future development. PyLaTeX however does support a wider array of python versions, perhaps the limited support of pythonTikz will be reviewed at a later date.

Currently one can install from the repository directly using pip:

pip install git+https://github.com/m-richards/pythonTikz.git

Currently, the package is not PyPi, however this should change as the project progresses.

Documentation

There currently is only one version of the docs, that is linked to the current master branch. Once out of alpha, the intent is to maintain a link to versions with an associated pypi release as well:

Contributing

Read the How to contribute page for tips and rules when you want to contribute.

Examples

The documentation is slowly showing more pythontikz specific examples of functionality. See Examples <https://m-richards.github .io/pythonTikz/examples.html>__ to compare the python, generated tex, and the output pdf.

The following picture shows raw PyLaTeX usage and does not demonstrate any of the additional features of pythontikz.

Copyright 2020 Matthew Richards, Original copyright: Copyright 2014 Jelte Fennema, under the MIT license

pythontikz's People

Contributors

m-richards avatar

Stargazers

Alexander Steppke avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.