pandoc-figure


Namepandoc-figure JSON
Version 0.1.0.5 PyPI version JSON
download
home_pageNone
SummaryA pandoc filter for adding complex figures
upload_time2024-10-22 09:28:10
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseBSD-3-Clause
keywords figure filters pandoc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Installation
============

[![Python package](https://github.com/chdemko/pandoc-figure/workflows/Python%20package/badge.svg?branch=develop)](https://github.com/chdemko/pandoc-figure/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-figure/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-figure?branch=develop)
[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/pandoc-figure.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/chdemko/pandoc-figure/)
[![Code Climate](https://codeclimate.com/github/chdemko/pandoc-figure/badges/gpa.svg)](https://codeclimate.com/github/chdemko/pandoc-figure/)
[![CodeFactor](https://img.shields.io/codefactor/grade/github/chdemko/pandoc-figure/develop.svg?logo=codefactor)](https://www.codefactor.io/repository/github/chdemko/pandoc-figure)
[![Codacy](https://img.shields.io/codacy/grade/36051716c52147bca7a7f4c1ca6bc998.svg?logo=codacy)](https://app.codacy.com/gh/chdemko/pandoc-figure/dashboard)
[![PyPI version](https://img.shields.io/pypi/v/pandoc-figure.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-figure/)
[![PyPI format](https://img.shields.io/pypi/format/pandoc-figure.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-figure/)
[![License](https://img.shields.io/pypi/l/pandoc-figure.svg?logo=pypi&logoColor=white)](https://raw.githubusercontent.com/chdemko/pandoc-figure/develop/LICENSE)
[![Downloads](https://img.shields.io/pypi/dm/pandoc-figure?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-figure)
[![Development Status](https://img.shields.io/pypi/status/pandoc-figure.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-figure/)
[![Python version](https://img.shields.io/pypi/pyversions/pandoc-figure.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-figure/)
[![Pandoc version](https://img.shields.io/badge/pandoc-3.0%20|%203.1%20|%203.2%20|%203.3%20|%203.4%20|%203.5-blue.svg?logo=markdown)](https://pandoc.org/)
[![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-figure.svg?logo=github)](https://github.com/chdemko/pandoc-figure/releases)
[![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-figure/develop?logo=github)](https://github.com/chdemko/pandoc-figure/commit/develop/)
[![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-figure.svg?logo=github)](http://pandoc-figure.readthedocs.io/en/latest/)
[![Code Size](https://img.shields.io/github/languages/code-size/chdemko/pandoc-figure.svg?logo=github)](http://pandoc-figure.readthedocs.io/en/latest/)
[![Source Rank](https://img.shields.io/librariesio/sourcerank/pypi/pandoc-figure.svg?logo=libraries.io&logoColor=white)](https://libraries.io/pypi/pandoc-figure)
[![Docs](https://img.shields.io/readthedocs/pandoc-figure.svg?logo=read-the-docs&logoColor=white)](http://pandoc-figure.readthedocs.io/en/latest/)

*pandoc-figure* is a [pandoc] filter for adding complex figures.

[pandoc]: http://pandoc.org/

Instructions
------------

*pandoc-figure* requires [python], a programming language that comes
pre-installed on linux and Mac OS X, and which is easily installed
[on Windows].

Install *pandoc-figure* using the bash command

~~~shell-session
$ pipx install pandoc-figure
~~~

To upgrade to the most recent release, use

~~~shell-session
$ pipx upgrade pandoc-figure
~~~

`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/).

[python]: https://www.python.org/
[on Windows]: https://www.python.org/downloads/windows/
[PyPI]: https://pypi.python.org/pypi


Getting Help
------------

If you have any difficulties with *pandoc-figure*, please feel welcome to
[file an issue] on github so that we can help.

[file an issue]: https://github.com/chdemko/pandoc-figure/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-figure",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": "Christophe Demko <chdemko@gmail.com>",
    "keywords": "figure, filters, pandoc",
    "author": null,
    "author_email": "Christophe Demko <chdemko@gmail.com>",
    "download_url": null,
    "platform": null,
    "description": "Installation\n============\n\n[![Python package](https://github.com/chdemko/pandoc-figure/workflows/Python%20package/badge.svg?branch=develop)](https://github.com/chdemko/pandoc-figure/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-figure/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-figure?branch=develop)\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/pandoc-figure.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/chdemko/pandoc-figure/)\n[![Code Climate](https://codeclimate.com/github/chdemko/pandoc-figure/badges/gpa.svg)](https://codeclimate.com/github/chdemko/pandoc-figure/)\n[![CodeFactor](https://img.shields.io/codefactor/grade/github/chdemko/pandoc-figure/develop.svg?logo=codefactor)](https://www.codefactor.io/repository/github/chdemko/pandoc-figure)\n[![Codacy](https://img.shields.io/codacy/grade/36051716c52147bca7a7f4c1ca6bc998.svg?logo=codacy)](https://app.codacy.com/gh/chdemko/pandoc-figure/dashboard)\n[![PyPI version](https://img.shields.io/pypi/v/pandoc-figure.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-figure/)\n[![PyPI format](https://img.shields.io/pypi/format/pandoc-figure.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-figure/)\n[![License](https://img.shields.io/pypi/l/pandoc-figure.svg?logo=pypi&logoColor=white)](https://raw.githubusercontent.com/chdemko/pandoc-figure/develop/LICENSE)\n[![Downloads](https://img.shields.io/pypi/dm/pandoc-figure?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-figure)\n[![Development Status](https://img.shields.io/pypi/status/pandoc-figure.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-figure/)\n[![Python version](https://img.shields.io/pypi/pyversions/pandoc-figure.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-figure/)\n[![Pandoc version](https://img.shields.io/badge/pandoc-3.0%20|%203.1%20|%203.2%20|%203.3%20|%203.4%20|%203.5-blue.svg?logo=markdown)](https://pandoc.org/)\n[![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-figure.svg?logo=github)](https://github.com/chdemko/pandoc-figure/releases)\n[![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-figure/develop?logo=github)](https://github.com/chdemko/pandoc-figure/commit/develop/)\n[![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-figure.svg?logo=github)](http://pandoc-figure.readthedocs.io/en/latest/)\n[![Code Size](https://img.shields.io/github/languages/code-size/chdemko/pandoc-figure.svg?logo=github)](http://pandoc-figure.readthedocs.io/en/latest/)\n[![Source Rank](https://img.shields.io/librariesio/sourcerank/pypi/pandoc-figure.svg?logo=libraries.io&logoColor=white)](https://libraries.io/pypi/pandoc-figure)\n[![Docs](https://img.shields.io/readthedocs/pandoc-figure.svg?logo=read-the-docs&logoColor=white)](http://pandoc-figure.readthedocs.io/en/latest/)\n\n*pandoc-figure* is a [pandoc] filter for adding complex figures.\n\n[pandoc]: http://pandoc.org/\n\nInstructions\n------------\n\n*pandoc-figure* 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-figure* using the bash command\n\n~~~shell-session\n$ pipx install pandoc-figure\n~~~\n\nTo upgrade to the most recent release, use\n\n~~~shell-session\n$ pipx upgrade pandoc-figure\n~~~\n\n`pipx` is a script to install and run python applications in isolated\nenvironments from the Python Package Index, [PyPI]. It can be installed\nusing instructions given [here](https://pipx.pypa.io/stable/).\n\n[python]: https://www.python.org/\n[on Windows]: https://www.python.org/downloads/windows/\n[PyPI]: https://pypi.python.org/pypi\n\n\nGetting Help\n------------\n\nIf you have any difficulties with *pandoc-figure*, please feel welcome to\n[file an issue] on github so that we can help.\n\n[file an issue]: https://github.com/chdemko/pandoc-figure/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 adding complex figures",
    "version": "0.1.0.5",
    "project_urls": {
        "Documentation": "https://pandoc-figure.readthedocs.io/",
        "Homepage": "https://github.com/chdemko/pandoc-figure",
        "Issues": "https://github.com/chdemko/pandoc-figure/issues",
        "Repository": "https://github.com/chdemko/pandoc-figure"
    },
    "split_keywords": [
        "figure",
        " filters",
        " pandoc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "55126f377a6008116e1265834c085627f32ddb7f036c451d8b79afc8ee31939c",
                "md5": "200e020041ca47e78424e661260f61b1",
                "sha256": "cd7626662caf5a6fa0a5d47662867f9970c8484fb2ac7e606a91a27ed546e72c"
            },
            "downloads": -1,
            "filename": "pandoc_figure-0.1.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "200e020041ca47e78424e661260f61b1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 5013,
            "upload_time": "2024-10-22T09:28:10",
            "upload_time_iso_8601": "2024-10-22T09:28:10.558240Z",
            "url": "https://files.pythonhosted.org/packages/55/12/6f377a6008116e1265834c085627f32ddb7f036c451d8b79afc8ee31939c/pandoc_figure-0.1.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-22 09:28:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "chdemko",
    "github_project": "pandoc-figure",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pandoc-figure"
}
        
Elapsed time: 0.37484s