============
snippet-fmt
============
.. start short_desc
**Format and validate code snippets in reStructuredText files.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/snippet-fmt/latest?logo=read-the-docs
:target: https://snippet-fmt.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/python-formate/snippet-fmt/workflows/Docs%20Check/badge.svg
:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/python-formate/snippet-fmt/workflows/Linux/badge.svg
:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/python-formate/snippet-fmt/workflows/Windows/badge.svg
:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/python-formate/snippet-fmt/workflows/macOS/badge.svg
:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/python-formate/snippet-fmt/workflows/Flake8/badge.svg
:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/python-formate/snippet-fmt/workflows/mypy/badge.svg
:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-formate/snippet-fmt/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/python-formate/snippet-fmt/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/snippet-fmt/master?logo=coveralls
:target: https://coveralls.io/github/python-formate/snippet-fmt?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/snippet-fmt?logo=codefactor
:target: https://www.codefactor.io/repository/github/python-formate/snippet-fmt
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/snippet-fmt
:target: https://pypi.org/project/snippet-fmt/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/snippet-fmt?logo=python&logoColor=white
:target: https://pypi.org/project/snippet-fmt/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/snippet-fmt
:target: https://pypi.org/project/snippet-fmt/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/snippet-fmt
:target: https://pypi.org/project/snippet-fmt/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/python-formate/snippet-fmt
:target: https://github.com/python-formate/snippet-fmt/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/python-formate/snippet-fmt
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/snippet-fmt/v0.1.5
:target: https://github.com/python-formate/snippet-fmt/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/snippet-fmt
:target: https://github.com/python-formate/snippet-fmt/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/snippet-fmt
:target: https://pypi.org/project/snippet-fmt/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``snippet-fmt`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install snippet-fmt
.. end installation
.. code-block:: python
def foo(bar):
print("hello")
.. code-block:: TOML
hello = "world
Raw data
{
"_id": null,
"home_page": "https://github.com/python-formate/snippet-fmt",
"name": "snippet-fmt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "docs,formatting,linting",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/cb/68/5f6ea954967a17fbda2ad1d90a8e02601cccb9956ea89538402ad7db801f/snippet_fmt-0.1.5.tar.gz",
"platform": "Windows",
"description": "\n============\nsnippet-fmt\n============\n\n.. start short_desc\n\n**Format and validate code snippets in reStructuredText files.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/snippet-fmt/latest?logo=read-the-docs\n\t:target: https://snippet-fmt.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/python-formate/snippet-fmt/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/python-formate/snippet-fmt/workflows/Linux/badge.svg\n\t:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/python-formate/snippet-fmt/workflows/Windows/badge.svg\n\t:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/python-formate/snippet-fmt/workflows/macOS/badge.svg\n\t:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/python-formate/snippet-fmt/workflows/Flake8/badge.svg\n\t:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/python-formate/snippet-fmt/workflows/mypy/badge.svg\n\t:target: https://github.com/python-formate/snippet-fmt/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-formate/snippet-fmt/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/python-formate/snippet-fmt/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/snippet-fmt/master?logo=coveralls\n\t:target: https://coveralls.io/github/python-formate/snippet-fmt?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/snippet-fmt?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/python-formate/snippet-fmt\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/snippet-fmt\n\t:target: https://pypi.org/project/snippet-fmt/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/snippet-fmt?logo=python&logoColor=white\n\t:target: https://pypi.org/project/snippet-fmt/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/snippet-fmt\n\t:target: https://pypi.org/project/snippet-fmt/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/snippet-fmt\n\t:target: https://pypi.org/project/snippet-fmt/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/python-formate/snippet-fmt\n\t:target: https://github.com/python-formate/snippet-fmt/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/python-formate/snippet-fmt\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/snippet-fmt/v0.1.5\n\t:target: https://github.com/python-formate/snippet-fmt/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/snippet-fmt\n\t:target: https://github.com/python-formate/snippet-fmt/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/snippet-fmt\n\t:target: https://pypi.org/project/snippet-fmt/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``snippet-fmt`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install snippet-fmt\n\n.. end installation\n\n\n.. code-block:: python\n\n\tdef foo(bar):\n\t\tprint(\"hello\")\n\n\n.. code-block:: TOML\n\n\thello = \"world\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Format and validate code snippets in reStructuredText files.",
"version": "0.1.5",
"project_urls": {
"Documentation": "https://snippet-fmt.readthedocs.io/en/latest",
"Homepage": "https://github.com/python-formate/snippet-fmt",
"Issue Tracker": "https://github.com/python-formate/snippet-fmt/issues",
"Source Code": "https://github.com/python-formate/snippet-fmt"
},
"split_keywords": [
"docs",
"formatting",
"linting"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "204f70cc1eaa683f3414fd30e44b674d3e79c75fadf2e993f820e1e5c5db161a",
"md5": "e4ce5c028e9c17c42f6f613e0e3b00e7",
"sha256": "e39abe3ddf8f79f04d4d679c0e03b9065cf4c8c64c30d9032176913f9fd107d0"
},
"downloads": -1,
"filename": "snippet_fmt-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4ce5c028e9c17c42f6f613e0e3b00e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 29077,
"upload_time": "2023-11-22T11:42:55",
"upload_time_iso_8601": "2023-11-22T11:42:55.315698Z",
"url": "https://files.pythonhosted.org/packages/20/4f/70cc1eaa683f3414fd30e44b674d3e79c75fadf2e993f820e1e5c5db161a/snippet_fmt-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb685f6ea954967a17fbda2ad1d90a8e02601cccb9956ea89538402ad7db801f",
"md5": "29a769c3ab337c3f7b21000b9c0567ec",
"sha256": "feff62ceabdc8da20eaa784d4e0abd5112210361d602b3e6ef1457e010be9772"
},
"downloads": -1,
"filename": "snippet_fmt-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "29a769c3ab337c3f7b21000b9c0567ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9104,
"upload_time": "2023-11-22T11:42:56",
"upload_time_iso_8601": "2023-11-22T11:42:56.583896Z",
"url": "https://files.pythonhosted.org/packages/cb/68/5f6ea954967a17fbda2ad1d90a8e02601cccb9956ea89538402ad7db801f/snippet_fmt-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 11:42:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-formate",
"github_project": "snippet-fmt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "snippet-fmt"
}
JSON
