{ "info": { "author": "Andre de Sousa Costa Filho", "author_email": "andre.filho001@outlook.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: Portuguese", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "

\n \n

Commit Helper

\n

\n\n

\n \n \"Build\n \n \n \"Maintainability\"\n \n \"codebeat\n \n \"Codacy\n \n \n \n \n \n

\n\n## What does it do?\nThe commit-helper do exactly what it's name suggest: helps you create and maintain your commit policy by tailoring your commit message into a commit convention.\n\n## Why should I use this?\nKeeping a commit policy may sound like an easy thing to do, but in reality we both know that it isn't.\n\nSometimes we, the developers, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?\n\n## Screenshots\n\n### Initial commit\n\n\n\n### Normal commit\n\n\n\n### Commit without generating a configuration file\n\n\n\n### Co-authored commit\n\n\n\n### Fast commit\n\n\n\n### Debugging and commiting\n\n\n\n### All-in-one commit\n\n\n\n### Help\n\n\n\n### Getting help for writing in a convention\n\n\n\n## Installation\n\nIn order to install one of our older versions, check our [previous releases](PREVIOUS_VERSIONS). To install the latest (pip) version, just follow the commands below:\n\n```bash\n$ pip3 install commit-helper\n```\n\n## Updating your current version\n\nIf you already have one of our `pip` releases installed in your machine and want to update to the latest version, use the command:\n\n```bash\n$ pip3 install --upgrade commit-helper\n```\n\n## Usage and configuration\n\nThis program has a cli that you can take advantage of. Running `commit --help`\nwill show you the usage and options for your commit. All of them are optional\nfor the sake of not losing your precious time.\n\n```bash\n $ commit -h\nusage: commit [-h] [-t TAG] [-m MESSAGE] [-ct CONTEXT] [-ca CO_AUTHOR] [-nf]\n [-c {angular,karma,tagged,symphony,message}] [-d]\n\nA commit formatter tool to help you follow commit conventions.\n\noptional arguments:\n -h, --help show this help message and exit\n -t TAG, --tag TAG Pass your commit tag directly\n -m MESSAGE, --message MESSAGE\n Pass your commit message directly\n -ct CONTEXT, --context CONTEXT\n Pass your commit context directly\n -ca CO_AUTHOR, --co-author CO_AUTHOR\n Make your friend an co-author to the commit\n -nf, --no-file Disables the creation of a commiter.yml file\n -c {angular,karma,tagged,symphony,message}, --convention {angular,karma,tagged,symphony,message}\n Selects a convention to be used for the commit.\n Required if there's no commiter.yml file.\n -d, --debug Toggles debug option\n\n```\n\nSo, if you want to write a co-authored commit, you should use:\n\n```bash\n$ commit --co-author \"foo bar doritous \"\n```\n\nOr if you are using this for the first time in your project:\n\n```bash\n$ commit --convention tagged\n```\n\nTo work even more smoothly, have in your working directory a file named **commiter.yml**. In this file you must pass the commit convention that you want to use, following the example:\n\n```yaml\nconvention: angular # tag(context): commit message\n\n# or\n\nconvention: karma # tag(context): commit message\n\n# or\n\nconvention: tagged # TAG: commit message\n\n# or\n\nconvention: symphony # [Tag] commit message\n\n# and if you're feeling adventurous\n\nconvention: none # Commit message\n```\n\nIn case that you or your organization does already have a commit convention that is not listed above, you can configure it in the commiter.yml file as following:\n\n```yaml\nconvention: custom\n# considering a commit message like '{add} (stuff) ~> in file foo.br'\ncommit_pattern: '{tag} (context) ~> message'\n# tag, message and context are reserved words that will be replaced in your commit message\ncontext: true # this is a must have field! If your pattern doesn't have one, assign false to it\n```\n\nSupported conventions available:\n\n - angular\n - karma\n - tagged\n - symphony\n - atom\n - only message (no convention)\n - a custom one that you may create :)\n\n ## Troubleshooting\n If after you've installed commit-helper the `commit` or `commit-helper` commands are not usable at the command line, check if `$HOME/.local/bin` is on your PATH. If not, add it on your .bashrc file by running:\n ``` bash\n$ echo \"export PATH=$HOME/.local/bin:$PATH\" >> .bashrc\n ```\n\n## Project's maintainers\n| **Name** | **Username** |\n| :--------: | :-----: |\n| Andr\u00e9 de Sousa Costa Filho | @andre-filho |\n\n## Our collaborators\n| **Name** | **Username** |\n| :------: | :----------: |\n| Arthur Jos\u00e9 Benedito de Oliveira Assis | @arthur0496 |\n| Matheus Richard Torres Gomes de Melo | @MatheusRich |\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/alaxalves/commit-helper", "keywords": "", "license": "GNU", "maintainer": "", "maintainer_email": "", "name": "commit-helper-testing", "package_url": "https://pypi.org/project/commit-helper-testing/", "platform": "", "project_url": "https://pypi.org/project/commit-helper-testing/", "project_urls": { "Homepage": "https://github.com/alaxalves/commit-helper" }, "release_url": "https://pypi.org/project/commit-helper-testing/3.4.8/", "requires_dist": [ "argh (==0.26.2)", "atomicwrites (==1.2.1)", "attrs (==18.2.0)", "certifi (==2018.11.29)", "chardet (==3.0.4)", "codacy-coverage (==1.3.11)", "codeclimate-test-reporter (==0.2.3)", "colorama (==0.4.1)", "colored (==1.3.93)", "coverage (==4.5.2)", "docopt (==0.6.2)", "idna (==2.8)", "more-itertools (==4.3.0)", "pathlib (==1.0.1)", "pathtools (==0.1.2)", "pip (==18.1)", "pluggy (==0.8.0)", "py (==1.7.0)", "pycodestyle (==2.4.0)", "pytest (==4.0.1)", "pytest-cov (==2.6.0)", "pytest-watch (==4.2.0)", "PyYAML (==3.13)", "requests (==2.21.0)", "setuptools (==40.6.2)", "six (==1.12.0)", "urllib3 (==1.24.1)", "watchdog (==0.9.0)", "wheel (==0.32.2)", "twine (==1.12.1)" ], "requires_python": "", "summary": "A python program that helps you write commits following commit conventions", "version": "3.4.8" }, "last_serial": 4632362, "releases": { "3.4.8": [ { "comment_text": "", "digests": { "md5": "86182679c76863bcc4896b63fc0057ff", "sha256": "6b99c2710d0f0b9391a69b2fe3f71d2d0e2c8cec563fb369a5dac3741dbc9a39" }, "downloads": -1, "filename": "commit_helper_testing-3.4.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "86182679c76863bcc4896b63fc0057ff", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 27400, "upload_time": "2018-12-25T00:10:24", "url": "https://files.pythonhosted.org/packages/8b/44/f0a12ffac21af91c13b6023b6456def8f94e1513c5a5c88b76fab3ffba34/commit_helper_testing-3.4.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e4f6139358c6ae1dd15a3b592fbb5c10", "sha256": "8bee26e4475ffb685dae5d2390102925585d8e43a9d9634edf2bccf2a65dc4bc" }, "downloads": -1, "filename": "commit-helper-testing-3.4.8.tar.gz", "has_sig": false, "md5_digest": "e4f6139358c6ae1dd15a3b592fbb5c10", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13110, "upload_time": "2018-12-25T00:10:26", "url": "https://files.pythonhosted.org/packages/3d/e8/8e1e3f2e7ace6649c183e92da5c4fe6f8493b3793d1d119fff496ae436e6/commit-helper-testing-3.4.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "86182679c76863bcc4896b63fc0057ff", "sha256": "6b99c2710d0f0b9391a69b2fe3f71d2d0e2c8cec563fb369a5dac3741dbc9a39" }, "downloads": -1, "filename": "commit_helper_testing-3.4.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "86182679c76863bcc4896b63fc0057ff", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 27400, "upload_time": "2018-12-25T00:10:24", "url": "https://files.pythonhosted.org/packages/8b/44/f0a12ffac21af91c13b6023b6456def8f94e1513c5a5c88b76fab3ffba34/commit_helper_testing-3.4.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e4f6139358c6ae1dd15a3b592fbb5c10", "sha256": "8bee26e4475ffb685dae5d2390102925585d8e43a9d9634edf2bccf2a65dc4bc" }, "downloads": -1, "filename": "commit-helper-testing-3.4.8.tar.gz", "has_sig": false, "md5_digest": "e4f6139358c6ae1dd15a3b592fbb5c10", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13110, "upload_time": "2018-12-25T00:10:26", "url": "https://files.pythonhosted.org/packages/3d/e8/8e1e3f2e7ace6649c183e92da5c4fe6f8493b3793d1d119fff496ae436e6/commit-helper-testing-3.4.8.tar.gz" } ] }