pandoc-numbering


Namepandoc-numbering JSON
Version 3.5.0.0 PyPI version JSON
download
home_pageNone
SummaryA pandoc filter for automatic numbering
upload_time2024-12-17 13:11:22
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseBSD-3-Clause
keywords filters numbering pandoc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Install
=======

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

*pandoc-numbering* is a [pandoc] filter for numbering all kinds of things.

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

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

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

Install *pandoc-numbering* using the bash command

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

To upgrade to the most recent release, use

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

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

Make sure you have the

* *tocloft*

LaTeX package. On linux you have to install some extra libraries **before**
*pandoc-numbering*. On a Debian-based system (including Ubuntu), you can
install it as root using

~~~shell-session
$ sudo apt-get install texlive-latex-extra
~~~

[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-numbering*, please feel welcome to
[file an issue] on github so that we can help.

[file an issue]: https://github.com/chdemko/pandoc-numbering/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-numbering",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": "Christophe Demko <chdemko@gmail.com>",
    "keywords": "filters, numbering, pandoc",
    "author": null,
    "author_email": "Christophe Demko <chdemko@gmail.com>",
    "download_url": null,
    "platform": null,
    "description": "Install\n=======\n\n[![Python package](https://img.shields.io/github/actions/workflow/status/chdemko/pandoc-numbering/python-package.yml?logo=github&branch=develop)](https://github.com/chdemko/pandoc-numbering/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-numbering/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-numbering?branch=develop)\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/pandoc-numbering.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/chdemko/pandoc-numbering/)\n[![Code Climate](https://img.shields.io/codeclimate/maintainability/chdemko/pandoc-numbering?logo=codeclimate&barnch=develop)](https://codeclimate.com/github/chdemko/pandoc-numbering/)\n[![CodeFactor](https://img.shields.io/codefactor/grade/github/chdemko/pandoc-numbering/develop.svg?logo=codefactor)](https://www.codefactor.io/repository/github/chdemko/pandoc-numbering)\n[![Codacy](https://img.shields.io/codacy/grade/36051716c52147bca7a7f4c1ca6bc998.svg?logo=codacy)](https://app.codacy.com/gh/chdemko/pandoc-numbering/dashboard)\n[![PyPI version](https://img.shields.io/pypi/v/pandoc-numbering.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-numbering/)\n[![PyPI format](https://img.shields.io/pypi/format/pandoc-numbering.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-numbering/)\n[![License](https://img.shields.io/pypi/l/pandoc-numbering.svg?logo=pypi&logoColor=white)](https://raw.githubusercontent.com/chdemko/pandoc-numbering/develop/LICENSE)\n[![Downloads](https://img.shields.io/pypi/dm/pandoc-numbering?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-numbering)\n[![Development Status](https://img.shields.io/pypi/status/pandoc-numbering.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-numbering/)\n[![Python version](https://img.shields.io/pypi/pyversions/pandoc-numbering.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-numbering/)\n[![Pandoc version](https://img.shields.io/badge/pandoc-2.14%20..%203.6-blue.svg?logo=markdown)](https://pandoc.org/)\n[![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-numbering.svg?logo=github)](https://github.com/chdemko/pandoc-numbering/releases)\n[![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-numbering/develop?logo=github)](https://github.com/chdemko/pandoc-numbering/commit/develop/)\n[![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-numbering.svg?logo=github)](http://pandoc-numbering.readthedocs.io/en/latest/)\n[![Code Size](https://img.shields.io/github/languages/code-size/chdemko/pandoc-numbering.svg?logo=github)](http://pandoc-numbering.readthedocs.io/en/latest/)\n[![Source Rank](https://img.shields.io/librariesio/sourcerank/pypi/pandoc-numbering.svg?logo=libraries.io&logoColor=white)](https://libraries.io/pypi/pandoc-numbering)\n[![Docs](https://img.shields.io/readthedocs/pandoc-numbering.svg?logo=read-the-docs&logoColor=white)](http://pandoc-numbering.readthedocs.io/en/latest/)\n\n*pandoc-numbering* is a [pandoc] filter for numbering all kinds of things.\n\n[pandoc]: http://pandoc.org/\n\nInstructions\n------------\n\n*pandoc-numbering* 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-numbering* using the bash command\n\n~~~shell-session\n$ pipx install pandoc-numbering\n~~~\n\nTo upgrade to the most recent release, use\n\n~~~shell-session\n$ pipx upgrade pandoc-numbering\n~~~\n\n`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/).\n\nMake sure you have the\n\n* *tocloft*\n\nLaTeX package. On linux you have to install some extra libraries **before**\n*pandoc-numbering*. On a Debian-based system (including Ubuntu), you can\ninstall it as root using\n\n~~~shell-session\n$ sudo apt-get install texlive-latex-extra\n~~~\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-numbering*, 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-numbering/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 automatic numbering",
    "version": "3.5.0.0",
    "project_urls": {
        "Coverage": "https://coveralls.io/github/chdemko/pandoc-numbering",
        "Documentation": "https://pandoc-numbering.readthedocs.io/",
        "Homepage": "https://github.com/chdemko/pandoc-numbering",
        "Issues": "https://github.com/chdemko/pandoc-numbering/issues",
        "Repository": "https://github.com/chdemko/pandoc-numbering"
    },
    "split_keywords": [
        "filters",
        " numbering",
        " pandoc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "22e2b3dce7cb4d38a605e4421bdc0de28e79a3f7abcbe3b91c19e53ddf0249df",
                "md5": "6865e1bceb88c69dd46d68303b0434bd",
                "sha256": "f0b78738069348512cdd4e148635d61eb2cf4568b7401166d93c9a7e73090c7b"
            },
            "downloads": -1,
            "filename": "pandoc_numbering-3.5.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6865e1bceb88c69dd46d68303b0434bd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 12534,
            "upload_time": "2024-12-17T13:11:22",
            "upload_time_iso_8601": "2024-12-17T13:11:22.654017Z",
            "url": "https://files.pythonhosted.org/packages/22/e2/b3dce7cb4d38a605e4421bdc0de28e79a3f7abcbe3b91c19e53ddf0249df/pandoc_numbering-3.5.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-17 13:11:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "chdemko",
    "github_project": "pandoc-numbering",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pandoc-numbering"
}
        
Elapsed time: 0.37159s