{ "info": { "author": "Noah Pendleton", "author_email": "2538614+noahp@users.noreply.github.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.6" ], "description": "[![Code style:\nblack](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/ambv/black)\n[![Travis (.com)\nbranch](https://img.shields.io/travis/com/noahp/py-commit-checker/master.svg?style=for-the-badge)](https://travis-ci.com/noahp/py-commit-checker)\n[![PyPI\nversion](https://img.shields.io/pypi/v/py-commit-checker.svg?style=for-the-badge)](https://pypi.org/project/py-commit-checker/)\n[![PyPI\npyversions](https://img.shields.io/pypi/pyversions/py-commit-checker.svg?style=for-the-badge)](https://pypi.python.org/pypi/py-commit-checker/)\n[![License:\nMIT](https://img.shields.io/badge/License-MIT-brightgreen.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)\n\n# \ud83d\udcdd py-commit-checker\n\nA basic git commit message format checker.\n\n# Checkers\n\nSmall set of mandatory (cannot be disabled) and optional (opt in or out) checkers.\n\n## Always enabled\n\nThese checks are always enabled:\n\n1. mandatory blank second line (delimiting title + body of message)\n\n## Optional\n\nThese checks can be set to on or off using command line args:\n\n1. [50/72](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)\n rule checking (configurable lengths)\n2. [leading emoji](https://gitmoji.carloscuesta.me/) check\n\nReturns non-zero in case of any violation\n\n# Install\n\n```bash\npip install py-commit-checker\n# note: you'll need git installed for the gitpython dependency to work!\n```\n\n# Usage\n\n```bash\n# check for 50/72 + emoji compliance on HEAD\npy-commit-checker --emojis\n\n# check a specific commit\npy-commit-checker --emojis --commit HEAD~2\n\n# check a repo at a path other than cwd\npy-commit-checker --repo-path ../openbsd\n```\n\n# Why is this not just a single regex\n\nBecause I was too lazy to figure out how to exclude URI elements from the body\nline length check in regex \ud83d\udc38\u2615.\n\nAlso distributing with pypi is pretty convenient \ud83d\ude00\n\n# Tests\n\nThis package uses tox. To run the tests locally:\n\n```bash\npip install tox==3.7.0 # minimum supported version\n\ntox --parallel auto # run tox in parallel\n```\n\nThis is a py2+3 universal package; it's recommended you install python3.6 with\nwhatever your system package manager is, if it isn't already installed, so tox\ncan run the checks for that too.\n\nTox will enforce 100% [pylint](https://www.pylint.org/) compliance, and\n[black](https://github.com/ambv/black) formatting compliance.\n\n# License\n\nMIT.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/noahp/py-commit-checker", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "py-commit-checker", "package_url": "https://pypi.org/project/py-commit-checker/", "platform": "", "project_url": "https://pypi.org/project/py-commit-checker/", "project_urls": { "Code": "https://github.com/noahp/py-commit-checker", "Homepage": "https://github.com/noahp/py-commit-checker", "Issue tracker": "https://github.com/noahp/py-commit-checker/issues" }, "release_url": "https://pypi.org/project/py-commit-checker/0.2.1/", "requires_dist": [ "click (>=6.5)", "emoji (>=0.5.1)", "gitpython (>=2.1.11)" ], "requires_python": "", "summary": "Basic commit checker, with optional emoji check", "version": "0.2.1" }, "last_serial": 4881753, "releases": { "0.0.0": [ { "comment_text": "", "digests": { "md5": "c8ca1210857cd151fd8badebb2c14886", "sha256": "672d54d20054bdf069953a791f7645fc673b669735c28e81f21d1f62dfbee7f4" }, "downloads": -1, "filename": "py_commit_checker-0.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c8ca1210857cd151fd8badebb2c14886", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4366, "upload_time": "2019-01-26T20:38:55", "url": "https://files.pythonhosted.org/packages/8e/ab/c0837208078a07423febdf68d61f5fb204b3622e1b2a171ac57431ee19cd/py_commit_checker-0.0.0-py2.py3-none-any.whl" } ], "0.0.1": [ { "comment_text": "", "digests": { "md5": "84e968a0818e5d6cfb4cbec5414dc1be", "sha256": "0ad59a345a6108343008261c4d628698cad4fea9f74ad70c03f378769191e28b" }, "downloads": -1, "filename": "py_commit_checker-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "84e968a0818e5d6cfb4cbec5414dc1be", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5001, "upload_time": "2019-01-28T17:23:27", "url": "https://files.pythonhosted.org/packages/78/eb/c3fc1a2cb594c3f54ddb9a90196137bc1e437812b153cbe46fd8b9439273/py_commit_checker-0.0.1-py2.py3-none-any.whl" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "ebd4eaef2874c92c704038ab8a763fd0", "sha256": "16fc87451f9af20c10acdad6d00b14d950a0df70304240ec3edcce230723cb93" }, "downloads": -1, "filename": "py_commit_checker-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ebd4eaef2874c92c704038ab8a763fd0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5680, "upload_time": "2019-01-29T00:46:50", "url": "https://files.pythonhosted.org/packages/a4/6b/c1987a5b78918d9d6e5c51fdb1a00875d821e9254f28b25e6a62ef2cdc32/py_commit_checker-0.1.0-py2.py3-none-any.whl" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "572714aedaad991d3358e4a29fdb959d", "sha256": "794edbd24022629e8d013c97518f994ca1095212a13dd618126af8c3a64393da" }, "downloads": -1, "filename": "py_commit_checker-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "572714aedaad991d3358e4a29fdb959d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5748, "upload_time": "2019-02-16T02:16:22", "url": "https://files.pythonhosted.org/packages/9a/c8/19c79c1e5c79d4136a380ec347ad9d652212cc48ef770053c03f077fcfef/py_commit_checker-0.2.0-py2.py3-none-any.whl" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "5d59d263d80a451e474d0a13c5824a27", "sha256": "5d7a5f95651ff99d2eb25aa33b38d30ae9fc12d66f4e3c450cdf053f652703a4" }, "downloads": -1, "filename": "py_commit_checker-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5d59d263d80a451e474d0a13c5824a27", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5680, "upload_time": "2019-03-01T00:47:57", "url": "https://files.pythonhosted.org/packages/0b/e1/1f3a9019501a6321538d0b2098e645210c661d5694cbd369f88aba052ded/py_commit_checker-0.2.1-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5d59d263d80a451e474d0a13c5824a27", "sha256": "5d7a5f95651ff99d2eb25aa33b38d30ae9fc12d66f4e3c450cdf053f652703a4" }, "downloads": -1, "filename": "py_commit_checker-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5d59d263d80a451e474d0a13c5824a27", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5680, "upload_time": "2019-03-01T00:47:57", "url": "https://files.pythonhosted.org/packages/0b/e1/1f3a9019501a6321538d0b2098e645210c661d5694cbd369f88aba052ded/py_commit_checker-0.2.1-py2.py3-none-any.whl" } ] }