checkstyle-cli
==============
|PyPI version| |pre-commit.ci status| |GitHub Workflow Status| |Documentation Status|
A command-line tool for |Checkstyle|_.
Requirements
------------
See |Requirements Documentation Page|_.
The minimum ``JRE`` version required depends on runtime of checkstyle.
Getting Started
---------------
See |Quickstart Documentation Page|_.
cli
~~~
.. code:: bash
$ pip install checkstyle-cli
pre-commit
~~~~~~~~~~
Add this to your ``.pre-commit-config.yaml``
.. parsed-literal::
repos:
- repo: https://github.com/junghoon-vans/checkstyle-cli
rev: |release|
hooks:
- id: checkstyle
License
-------
`MIT
License <https://github.com/junghoon-vans/checkstyle-cli/blob/main/LICENSE>`__
.. |Checkstyle| replace:: checkstyle
.. _Checkstyle: https://checkstyle.sourceforge.io
.. |Requirements Documentation Page| replace:: requirements documentation
.. _Requirements Documentation Page: https://checkstyle-cli.readthedocs.io/en/latest/user_guide/requirements.html
.. |Quickstart Documentation Page| replace:: quickstart documentation
.. _Quickstart Documentation Page: https://checkstyle-cli.readthedocs.io/en/latest/index.html#quickstart
.. |PyPI version| image:: https://img.shields.io/pypi/v/checkstyle-cli
:target: https://pypi.org/project/checkstyle-cli/
.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/junghoon-vans/checkstyle-cli/main.svg
:target: https://results.pre-commit.ci/latest/github/junghoon-vans/checkstyle-cli/main
.. |GitHub Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/junghoon-vans/checkstyle-cli/python-publish.yml?branch=v0.7.0
.. |Documentation Status| image:: https://readthedocs.org/projects/checkstyle-cli/badge/?version=latest
:target: https://checkstyle-cli.readthedocs.io/en/latest/?badge=latest
.. |release| replace:: v0.7.0
Raw data
{
"_id": null,
"home_page": "https://github.com/junghoon-vans/checkstyle-cli",
"name": "checkstyle-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "junghoon-vans",
"author_email": "junghoon.ban@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f8/2e/0a5bd166571dba3cb1cc43b891182d10b544506a8dfb0451ce9ed8b3cb5a/checkstyle_cli-0.7.1.tar.gz",
"platform": null,
"description": "checkstyle-cli\n==============\n\n|PyPI version| |pre-commit.ci status| |GitHub Workflow Status| |Documentation Status|\n\nA command-line tool for |Checkstyle|_.\n\nRequirements\n------------\n\n See |Requirements Documentation Page|_.\n\nThe minimum ``JRE`` version required depends on runtime of checkstyle.\n\nGetting Started\n---------------\n\n See |Quickstart Documentation Page|_.\n\ncli\n~~~\n\n.. code:: bash\n\n $ pip install checkstyle-cli\n\npre-commit\n~~~~~~~~~~\n\nAdd this to your ``.pre-commit-config.yaml``\n\n.. parsed-literal::\n\n repos:\n - repo: https://github.com/junghoon-vans/checkstyle-cli\n rev: |release|\n hooks:\n - id: checkstyle\n\nLicense\n-------\n\n`MIT\nLicense <https://github.com/junghoon-vans/checkstyle-cli/blob/main/LICENSE>`__\n\n.. |Checkstyle| replace:: checkstyle\n.. _Checkstyle: https://checkstyle.sourceforge.io\n.. |Requirements Documentation Page| replace:: requirements documentation\n.. _Requirements Documentation Page: https://checkstyle-cli.readthedocs.io/en/latest/user_guide/requirements.html\n.. |Quickstart Documentation Page| replace:: quickstart documentation\n.. _Quickstart Documentation Page: https://checkstyle-cli.readthedocs.io/en/latest/index.html#quickstart\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/checkstyle-cli\n :target: https://pypi.org/project/checkstyle-cli/\n.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/junghoon-vans/checkstyle-cli/main.svg\n :target: https://results.pre-commit.ci/latest/github/junghoon-vans/checkstyle-cli/main\n.. |GitHub Workflow Status| image:: https://img.shields.io/github/actions/workflow/status/junghoon-vans/checkstyle-cli/python-publish.yml?branch=v0.7.0\n.. |Documentation Status| image:: https://readthedocs.org/projects/checkstyle-cli/badge/?version=latest\n :target: https://checkstyle-cli.readthedocs.io/en/latest/?badge=latest\n\n.. |release| replace:: v0.7.0\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool for checkstyle.",
"version": "0.7.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "055eb097f0c16098692b94597ac82cce8a46ca2373d7cf95b60481211ee283e8",
"md5": "9383e84601582a85f6b5d84dcadc88b4",
"sha256": "fc7a73ecd2cdd169728b63bc702c09a6f977cba7071b60b6518b0149dfeaed03"
},
"downloads": -1,
"filename": "checkstyle_cli-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9383e84601582a85f6b5d84dcadc88b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7330,
"upload_time": "2023-03-19T10:56:48",
"upload_time_iso_8601": "2023-03-19T10:56:48.306778Z",
"url": "https://files.pythonhosted.org/packages/05/5e/b097f0c16098692b94597ac82cce8a46ca2373d7cf95b60481211ee283e8/checkstyle_cli-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f82e0a5bd166571dba3cb1cc43b891182d10b544506a8dfb0451ce9ed8b3cb5a",
"md5": "9ede0e52adf5ad45ea934a19a72e0d1a",
"sha256": "4b51e9242b77b1b5874811e3aad48cf58e03089d62ef0662004de583c681e2e4"
},
"downloads": -1,
"filename": "checkstyle_cli-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "9ede0e52adf5ad45ea934a19a72e0d1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7102,
"upload_time": "2023-03-19T10:56:49",
"upload_time_iso_8601": "2023-03-19T10:56:49.929390Z",
"url": "https://files.pythonhosted.org/packages/f8/2e/0a5bd166571dba3cb1cc43b891182d10b544506a8dfb0451ce9ed8b3cb5a/checkstyle_cli-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-19 10:56:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "junghoon-vans",
"github_project": "checkstyle-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "checkstyle-cli"
}
JSON
