latexify-py


Namelatexify-py JSON
Version 0.4.3.post1 PyPI version JSON
download
home_pageNone
SummaryGenerates LaTeX math description from Python functions.
upload_time2024-03-26 04:01:50
maintainerNone
docs_urlNone
authorNone
requires_python<3.12,>=3.7
licenseApache Software License 2.0
keywords equation latex math mathematics tex
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # latexify

[![Python](https://img.shields.io/pypi/pyversions/latexify-py.svg)](https://pypi.org/project/latexify-py/)
[![PyPI Latest Release](https://img.shields.io/pypi/v/latexify-py.svg)](https://pypi.org/project/latexify-py/)
[![License](https://img.shields.io/pypi/l/latexify-py.svg)](https://github.com/google/latexify_py/blob/main/LICENSE)
[![Downloads](https://pepy.tech/badge/latexify-py/month)](https://pepy.tech/project/latexify-py)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

`latexify` is a Python package to compile a fragment of Python source code to a
corresponding $\LaTeX$ expression:

![Example of latexify usage](https://raw.githubusercontent.com/google/latexify_py/main/example.jpg)

`latexify` provides the following functionalities:

* Libraries to compile Python source code or AST to $\LaTeX$.
* IPython classes to pretty-print compiled functions.

## FAQs

1. *Which Python versions are supported?*

   Syntaxes on **Pythons 3.7 to 3.11** are officially supported, or will be supported.

2. *Which technique is used?*

   `latexify` is implemented as a rule-based system on the official `ast` package.

3. *Are "AI" techniques adopted?*

   `latexify` is based on traditional parsing techniques.
   If the "AI" meant some techniques around machine learning, the answer is no.

## Getting started

See the
[example notebook](https://github.com/google/latexify_py/blob/main/examples/latexify_examples.ipynb),
which provides several
use-cases of this library.

You can also try the above notebook on
[Google Colaboratory](https://colab.research.google.com/github/google/latexify_py/blob/main/examples/latexify_examples.ipynb).

See also the official
[documentation](https://github.com/google/latexify_py/blob/main/docs/index.md)
for more details.

## How to Contribute

To contribute to this project, please refer
[CONTRIBUTING.md](https://github.com/google/latexify_py/blob/develop/CONTRIBUTING.md).

## Disclaimer

This software is currently hosted on <https://github.com/google>, but not officially
supported by Google.

If you have any issues and/or questions about this software, please visit the
[issue tracker](https://github.com/google/latexify_py/issues)
or contact the [main maintainer](https://github.com/odashi).

## License

This software adopts the
[Apache License 2.0](https://github.com/google/latexify_py/blob/develop/LICENSE).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "latexify-py",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.7",
    "maintainer_email": null,
    "keywords": "equation, latex, math, mathematics, tex",
    "author": null,
    "author_email": "Yusuke Oda <odashi@inspiredco.ai>",
    "download_url": "https://files.pythonhosted.org/packages/d8/9d/bb7416b97c7fcf882e6a2c599ab707686b97748a7f9b833ad1a8e47c06d5/latexify_py-0.4.3.post1.tar.gz",
    "platform": null,
    "description": "# latexify\n\n[![Python](https://img.shields.io/pypi/pyversions/latexify-py.svg)](https://pypi.org/project/latexify-py/)\n[![PyPI Latest Release](https://img.shields.io/pypi/v/latexify-py.svg)](https://pypi.org/project/latexify-py/)\n[![License](https://img.shields.io/pypi/l/latexify-py.svg)](https://github.com/google/latexify_py/blob/main/LICENSE)\n[![Downloads](https://pepy.tech/badge/latexify-py/month)](https://pepy.tech/project/latexify-py)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n\n`latexify` is a Python package to compile a fragment of Python source code to a\ncorresponding $\\LaTeX$ expression:\n\n![Example of latexify usage](https://raw.githubusercontent.com/google/latexify_py/main/example.jpg)\n\n`latexify` provides the following functionalities:\n\n* Libraries to compile Python source code or AST to $\\LaTeX$.\n* IPython classes to pretty-print compiled functions.\n\n## FAQs\n\n1. *Which Python versions are supported?*\n\n   Syntaxes on **Pythons 3.7 to 3.11** are officially supported, or will be supported.\n\n2. *Which technique is used?*\n\n   `latexify` is implemented as a rule-based system on the official `ast` package.\n\n3. *Are \"AI\" techniques adopted?*\n\n   `latexify` is based on traditional parsing techniques.\n   If the \"AI\" meant some techniques around machine learning, the answer is no.\n\n## Getting started\n\nSee the\n[example notebook](https://github.com/google/latexify_py/blob/main/examples/latexify_examples.ipynb),\nwhich provides several\nuse-cases of this library.\n\nYou can also try the above notebook on\n[Google Colaboratory](https://colab.research.google.com/github/google/latexify_py/blob/main/examples/latexify_examples.ipynb).\n\nSee also the official\n[documentation](https://github.com/google/latexify_py/blob/main/docs/index.md)\nfor more details.\n\n## How to Contribute\n\nTo contribute to this project, please refer\n[CONTRIBUTING.md](https://github.com/google/latexify_py/blob/develop/CONTRIBUTING.md).\n\n## Disclaimer\n\nThis software is currently hosted on <https://github.com/google>, but not officially\nsupported by Google.\n\nIf you have any issues and/or questions about this software, please visit the\n[issue tracker](https://github.com/google/latexify_py/issues)\nor contact the [main maintainer](https://github.com/odashi).\n\n## License\n\nThis software adopts the\n[Apache License 2.0](https://github.com/google/latexify_py/blob/develop/LICENSE).\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Generates LaTeX math description from Python functions.",
    "version": "0.4.3.post1",
    "project_urls": {
        "Bug Tracker": "https://github.com/google/latexify_py/issues",
        "Homepage": "https://github.com/google/latexify_py"
    },
    "split_keywords": [
        "equation",
        " latex",
        " math",
        " mathematics",
        " tex"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4347cae4336cf30cd3ba3a678352139a7bceffe04a4be0ee5e411425ca51304f",
                "md5": "ed7f9e5e2c7d5d8e3beca17c136dcab3",
                "sha256": "36b493358a90d80b6abb89eb7560eeff89ca5ea29db2187f7327851cfc96192a"
            },
            "downloads": -1,
            "filename": "latexify_py-0.4.3.post1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ed7f9e5e2c7d5d8e3beca17c136dcab3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.7",
            "size": 38281,
            "upload_time": "2024-03-26T04:01:49",
            "upload_time_iso_8601": "2024-03-26T04:01:49.575876Z",
            "url": "https://files.pythonhosted.org/packages/43/47/cae4336cf30cd3ba3a678352139a7bceffe04a4be0ee5e411425ca51304f/latexify_py-0.4.3.post1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d89dbb7416b97c7fcf882e6a2c599ab707686b97748a7f9b833ad1a8e47c06d5",
                "md5": "04f725d8d8e543715d94c8ff9e00338c",
                "sha256": "17ba32c748c61392de9f78ad50059a91b4d64832a44b7df68c167a3f68b7421b"
            },
            "downloads": -1,
            "filename": "latexify_py-0.4.3.post1.tar.gz",
            "has_sig": false,
            "md5_digest": "04f725d8d8e543715d94c8ff9e00338c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.7",
            "size": 29429,
            "upload_time": "2024-03-26T04:01:50",
            "upload_time_iso_8601": "2024-03-26T04:01:50.778155Z",
            "url": "https://files.pythonhosted.org/packages/d8/9d/bb7416b97c7fcf882e6a2c599ab707686b97748a7f9b833ad1a8e47c06d5/latexify_py-0.4.3.post1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-26 04:01:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "google",
    "github_project": "latexify_py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "latexify-py"
}
        
Elapsed time: 0.23228s