tomlcheck
==========
.. image:: https://img.shields.io/pypi/v/tomlcheck.svg
:target: https://pypi.org/project/tomlcheck
:alt:
.. image:: https://img.shields.io/pypi/pyversions/tomlcheck.svg
:target: https://pypi.org/project/tomlcheck
:alt:
.. image:: https://travis-ci.com/sayanarijit/tomlcheck.svg?branch=master
:target: https://travis-ci.com/sayanarijit/tomlcheck
:alt:
.. image:: https://codecov.io/gh/sayanarijit/tomlcheck/branch/master/graph/badge.svg
:target: https://codecov.io/gh/sayanarijit/tomlcheck
:alt:
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/python/black
:alt:
A simple toml syntax checker.
Designed to be used by `pre-commit <https://github.com/pre-commit/pre-commit>`_ hooks.
Installation
------------
.. code-block:: bash
pip install -U tomlcheck
Usage
-----
Check files:
.. code-block:: bash
tomlcheck $(find . -type f -name "*.toml")
# Or read from stdin
find . -type f -name "*.toml" | tomlcheck -
With logging:
.. code-block:: bash
tomlcheck --log-level DEBUG $(find . -type f -name "*.toml")
# Or read from stdin
find . -type f -name "*.toml" | tomlcheck --log-level DEBUG -
In `pre-commit <https://github.com/pre-commit/pre-commit>`_ config:
.. code-block:: yaml
# .pre-commit-config.yaml
- repo: local
hooks:
- id: tomlcheck
name: Check TOML Syntax
description: Checks TOML files for valid syntax.
entry: tomlcheck
language: system
files: \**/*.toml$
stages: [commit, push, manual]
Help Menu
---------
.. code-block:: bash
tomlcheck --help
Raw data
{
"_id": null,
"home_page": "http://github.com/sayanarijit/tomlcheck",
"name": "tomlcheck",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.6",
"maintainer_email": null,
"keywords": "toml, toml-validation, pre-commit, pre-commit-hooks",
"author": "Arijit Basu",
"author_email": "sayanarijit@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e9/4b/4ceedc53234fbea932bd6db9e63ca7d139356c1461cd8f7a5c4d19910375/tomlcheck-0.2.3.tar.gz",
"platform": null,
"description": "tomlcheck\n==========\n\n.. image:: https://img.shields.io/pypi/v/tomlcheck.svg\n :target: https://pypi.org/project/tomlcheck\n :alt:\n\n.. image:: https://img.shields.io/pypi/pyversions/tomlcheck.svg\n :target: https://pypi.org/project/tomlcheck\n :alt:\n\n.. image:: https://travis-ci.com/sayanarijit/tomlcheck.svg?branch=master\n :target: https://travis-ci.com/sayanarijit/tomlcheck\n :alt:\n\n.. image:: https://codecov.io/gh/sayanarijit/tomlcheck/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/sayanarijit/tomlcheck\n :alt:\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/python/black\n :alt:\n\n\nA simple toml syntax checker.\n\nDesigned to be used by `pre-commit <https://github.com/pre-commit/pre-commit>`_ hooks.\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install -U tomlcheck\n\n\nUsage\n-----\n\nCheck files:\n\n.. code-block:: bash\n\n tomlcheck $(find . -type f -name \"*.toml\")\n\n # Or read from stdin\n\n find . -type f -name \"*.toml\" | tomlcheck -\n\n\nWith logging:\n\n.. code-block:: bash\n\n tomlcheck --log-level DEBUG $(find . -type f -name \"*.toml\")\n \n # Or read from stdin\n\n find . -type f -name \"*.toml\" | tomlcheck --log-level DEBUG -\n\nIn `pre-commit <https://github.com/pre-commit/pre-commit>`_ config:\n\n.. code-block:: yaml\n\n # .pre-commit-config.yaml\n\n - repo: local\n hooks:\n - id: tomlcheck\n name: Check TOML Syntax\n description: Checks TOML files for valid syntax.\n entry: tomlcheck\n language: system\n files: \\**/*.toml$\n stages: [commit, push, manual]\n\n\nHelp Menu\n---------\n\n.. code-block:: bash\n\n tomlcheck --help\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple toml syntax checker",
"version": "0.2.3",
"project_urls": {
"Homepage": "http://github.com/sayanarijit/tomlcheck",
"Repository": "http://github.com/sayanarijit/tomlcheck"
},
"split_keywords": [
"toml",
" toml-validation",
" pre-commit",
" pre-commit-hooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47d43f06ee42f779f1acccb568e108055811bfd98d085df3e92413c1dfc2b2ad",
"md5": "5e2d74009fa39e937eca386d7db1471f",
"sha256": "6f4f9e4e87e83b5d7577fbca63f3f51712b986781ee6ff69987d3c0cd703425d"
},
"downloads": -1,
"filename": "tomlcheck-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e2d74009fa39e937eca386d7db1471f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.6",
"size": 3152,
"upload_time": "2024-06-22T05:04:27",
"upload_time_iso_8601": "2024-06-22T05:04:27.250509Z",
"url": "https://files.pythonhosted.org/packages/47/d4/3f06ee42f779f1acccb568e108055811bfd98d085df3e92413c1dfc2b2ad/tomlcheck-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e94b4ceedc53234fbea932bd6db9e63ca7d139356c1461cd8f7a5c4d19910375",
"md5": "687f9dfd3daae55b3a9d0e0c1639d6d6",
"sha256": "0865ae7ccaf41f1a36a3b0de48c59289d9a5d00998fcd338199c8c69ddd11405"
},
"downloads": -1,
"filename": "tomlcheck-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "687f9dfd3daae55b3a9d0e0c1639d6d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.6",
"size": 2318,
"upload_time": "2024-06-22T05:04:29",
"upload_time_iso_8601": "2024-06-22T05:04:29.081361Z",
"url": "https://files.pythonhosted.org/packages/e9/4b/4ceedc53234fbea932bd6db9e63ca7d139356c1461cd8f7a5c4d19910375/tomlcheck-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-22 05:04:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sayanarijit",
"github_project": "tomlcheck",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "tomlcheck"
}
JSON
