Installation
============
[![Python package](https://img.shields.io/github/actions/workflow/status/chdemko/pandoc-latex-color/python-package.yml?logo=github&branch=develop)](https://github.com/chdemko/pandoc-latex-color/actions/workflows/python-package.yml)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://pypi.org/project/black/)
[![Coveralls](https://img.shields.io/coveralls/github/chdemko/pandoc-latex-color/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-latex-color?branch=develop)
[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/pandoc-latex-color.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-color/)
[![Code Climate](https://img.shields.io/codeclimate/maintainability/chdemko/pandoc-latex-color?logo=codeclimate&barnch=develop)](https://codeclimate.com/github/chdemko/pandoc-latex-color/)
[![CodeFactor](https://img.shields.io/codefactor/grade/github/chdemko/pandoc-latex-color/develop.svg?logo=codefactor)](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-color)
[![Codacy](https://img.shields.io/codacy/grade/68aedbacd7a543cebe982966434f6d68.svg?logo=codacy)](https://app.codacy.com/gh/chdemko/pandoc-latex-color/dashboard)
[![PyPI version](https://img.shields.io/pypi/v/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)
[![PyPI format](https://img.shields.io/pypi/format/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)
[![License](https://img.shields.io/pypi/l/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://raw.githubusercontent.com/chdemko/pandoc-latex-color/develop/LICENSE)
[![Downloads](https://img.shields.io/pypi/dm/pandoc-latex-color?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-latex-color)
[![Development Status](https://img.shields.io/pypi/status/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)
[![Python version](https://img.shields.io/pypi/pyversions/pandoc-latex-color.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)
[![Pandoc version](https://img.shields.io/badge/pandoc-2.11%20..%203.6-blue.svg?logo=markdown)](https://pandoc.org/)
[![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-latex-color.svg?logo=github)](https://github.com/chdemko/pandoc-latex-color/releases)
[![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-latex-color/develop?logo=github)](https://github.com/chdemko/pandoc-latex-color/commit/develop/)
[![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-latex-color.svg?logo=github)](http://pandoc-latex-color.readthedocs.io/en/latest/)
[![Code Size](https://img.shields.io/github/languages/code-size/chdemko/pandoc-latex-color.svg?logo=github)](http://pandoc-latex-color.readthedocs.io/en/latest/)
[![Source Rank](https://img.shields.io/librariesio/sourcerank/pypi/pandoc-latex-color.svg?logo=libraries.io&logoColor=white)](https://libraries.io/pypi/pandoc-latex-color)
[![Docs](https://img.shields.io/readthedocs/pandoc-latex-color.svg?logo=read-the-docs&logoColor=white)](http://pandoc-latex-color.readthedocs.io/en/latest/)
*pandoc-latex-color* is a [pandoc] filter for setting the color to `Span`
that have speficied classes or `latex-color` attribute.
[pandoc]: http://pandoc.org/
Instructions
------------
*pandoc-latex-color* requires [python], a programming language that comes
pre-installed on linux and Mac OS X, and which is easily installed
[on Windows].
Install *pandoc-latex-color* using the bash command
~~~shell-session
$ pipx install pandoc-latex-color
~~~
To upgrade to the most recent release, use
~~~shell-session
$ pipx upgrade pandoc-latex-color
~~~
`pipx` is a script to install and run python applications in isolated
environments from the Python Package Index, [PyPI].
It can be installed using instructions given
[here](https://pipx.pypa.io/stable/).
It uses the *xcolor* LaTeX package to handle correctly colors in spans
and the *soulutf8* package for highlighing the text.
[python]: https://www.python.org
[on Windows]: https://www.python.org/downloads/windows
[PyPI]: https://pypi.org
Getting Help
------------
If you have any difficulties with *pandoc-latex-color*,
please feel welcome to [file an issue] on github so that we can help.
[file an issue]: https://github.com/chdemko/pandoc-latex-color/issues
Contribute
==========
Instructions
------------
Install `hatch`, then run
~~~shell-session
$ hatch run pip install pre-commit
$ hatch run pre-commit install
~~~
to install `pre-commit` before working on your changes.
Tests
-----
When your changes are ready, run
~~~shell-session
$ hatch test
$ hatch fmt --check
$ hatch run lint:check
$ hatch run docs:build
$ hatch build -t wheel
~~~
for running the tests, checking the style, building the documentation
and building the wheel.
Raw data
{
"_id": null,
"home_page": null,
"name": "pandoc-latex-color",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "Christophe Demko <chdemko@gmail.com>",
"keywords": "color, filters, latex, pandoc",
"author": null,
"author_email": "Christophe Demko <chdemko@gmail.com>",
"download_url": null,
"platform": null,
"description": "Installation\n============\n\n[![Python package](https://img.shields.io/github/actions/workflow/status/chdemko/pandoc-latex-color/python-package.yml?logo=github&branch=develop)](https://github.com/chdemko/pandoc-latex-color/actions/workflows/python-package.yml)\n[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://pypi.org/project/black/)\n[![Coveralls](https://img.shields.io/coveralls/github/chdemko/pandoc-latex-color/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-latex-color?branch=develop)\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/pandoc-latex-color.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/chdemko/pandoc-latex-color/)\n[![Code Climate](https://img.shields.io/codeclimate/maintainability/chdemko/pandoc-latex-color?logo=codeclimate&barnch=develop)](https://codeclimate.com/github/chdemko/pandoc-latex-color/)\n[![CodeFactor](https://img.shields.io/codefactor/grade/github/chdemko/pandoc-latex-color/develop.svg?logo=codefactor)](https://www.codefactor.io/repository/github/chdemko/pandoc-latex-color)\n[![Codacy](https://img.shields.io/codacy/grade/68aedbacd7a543cebe982966434f6d68.svg?logo=codacy)](https://app.codacy.com/gh/chdemko/pandoc-latex-color/dashboard)\n[![PyPI version](https://img.shields.io/pypi/v/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)\n[![PyPI format](https://img.shields.io/pypi/format/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)\n[![License](https://img.shields.io/pypi/l/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://raw.githubusercontent.com/chdemko/pandoc-latex-color/develop/LICENSE)\n[![Downloads](https://img.shields.io/pypi/dm/pandoc-latex-color?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-latex-color)\n[![Development Status](https://img.shields.io/pypi/status/pandoc-latex-color.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)\n[![Python version](https://img.shields.io/pypi/pyversions/pandoc-latex-color.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-latex-color/)\n[![Pandoc version](https://img.shields.io/badge/pandoc-2.11%20..%203.6-blue.svg?logo=markdown)](https://pandoc.org/)\n[![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-latex-color.svg?logo=github)](https://github.com/chdemko/pandoc-latex-color/releases)\n[![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-latex-color/develop?logo=github)](https://github.com/chdemko/pandoc-latex-color/commit/develop/)\n[![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-latex-color.svg?logo=github)](http://pandoc-latex-color.readthedocs.io/en/latest/)\n[![Code Size](https://img.shields.io/github/languages/code-size/chdemko/pandoc-latex-color.svg?logo=github)](http://pandoc-latex-color.readthedocs.io/en/latest/)\n[![Source Rank](https://img.shields.io/librariesio/sourcerank/pypi/pandoc-latex-color.svg?logo=libraries.io&logoColor=white)](https://libraries.io/pypi/pandoc-latex-color)\n[![Docs](https://img.shields.io/readthedocs/pandoc-latex-color.svg?logo=read-the-docs&logoColor=white)](http://pandoc-latex-color.readthedocs.io/en/latest/)\n\n*pandoc-latex-color* is a [pandoc] filter for setting the color to `Span`\nthat have speficied classes or `latex-color` attribute.\n\n[pandoc]: http://pandoc.org/\n\nInstructions\n------------\n\n*pandoc-latex-color* requires [python], a programming language that comes\npre-installed on linux and Mac OS X, and which is easily installed\n[on Windows].\n\nInstall *pandoc-latex-color* using the bash command\n\n~~~shell-session\n$ pipx install pandoc-latex-color\n~~~\n\nTo upgrade to the most recent release, use\n\n~~~shell-session\n$ pipx upgrade pandoc-latex-color\n~~~\n\n`pipx` is a script to install and run python applications in isolated\nenvironments from the Python Package Index, [PyPI].\nIt can be installed using instructions given\n[here](https://pipx.pypa.io/stable/).\n\nIt uses the *xcolor* LaTeX package to handle correctly colors in spans\nand the *soulutf8* package for highlighing the text.\n\n[python]: https://www.python.org\n[on Windows]: https://www.python.org/downloads/windows\n[PyPI]: https://pypi.org\n\n\nGetting Help\n------------\n\nIf you have any difficulties with *pandoc-latex-color*,\nplease feel welcome to [file an issue] on github so that we can help.\n\n[file an issue]: https://github.com/chdemko/pandoc-latex-color/issues\n\nContribute\n==========\n\nInstructions\n------------\n\nInstall `hatch`, then run\n\n~~~shell-session\n$ hatch run pip install pre-commit\n$ hatch run pre-commit install\n~~~\n\nto install `pre-commit` before working on your changes.\n\nTests\n-----\n\nWhen your changes are ready, run\n\n~~~shell-session\n$ hatch test\n$ hatch fmt --check\n$ hatch run lint:check\n$ hatch run docs:build\n$ hatch build -t wheel\n~~~\n\nfor running the tests, checking the style, building the documentation\nand building the wheel.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A pandoc filter for changing color in LaTeX",
"version": "2.1.0.0",
"project_urls": {
"Documentation": "https://pandoc-latex-color.readthedocs.io/",
"Homepage": "https://github.com/chdemko/pandoc-latex-color",
"Issues": "https://github.com/chdemko/pandoc-latex-color/issues",
"Repository": "https://github.com/chdemko/pandoc-latex-color"
},
"split_keywords": [
"color",
" filters",
" latex",
" pandoc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "10682de934c7ac0c60290efd9465f112510c80b3e0b9cf64ed5f7d5b41183fa9",
"md5": "6d16a245c16e120988ca29d39a3e354e",
"sha256": "b255e68199f454b36ac09941e977d4f0dedff08d3845b370efa8976f37251c2c"
},
"downloads": -1,
"filename": "pandoc_latex_color-2.1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d16a245c16e120988ca29d39a3e354e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 7675,
"upload_time": "2024-12-17T11:41:21",
"upload_time_iso_8601": "2024-12-17T11:41:21.179854Z",
"url": "https://files.pythonhosted.org/packages/10/68/2de934c7ac0c60290efd9465f112510c80b3e0b9cf64ed5f7d5b41183fa9/pandoc_latex_color-2.1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 11:41:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chdemko",
"github_project": "pandoc-latex-color",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pandoc-latex-color"
}