{"id":26518755,"url":"https://github.com/nebbles/gitcommit","last_synced_at":"2025-03-21T10:02:09.734Z","repository":{"id":57417566,"uuid":"209867969","full_name":"nebbles/gitcommit","owner":"nebbles","description":"a tool for writing conventional commits, conveniently","archived":true,"fork":false,"pushed_at":"2023-07-25T16:53:53.000Z","size":104,"stargazers_count":14,"open_issues_count":25,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T19:48:57.535Z","etag":null,"topics":["cli","commitizen","commits","conventional-commits","git","gitcommit","python3","semantic-versioning"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nebbles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-20T19:38:48.000Z","updated_at":"2024-08-09T20:31:03.000Z","dependencies_parsed_at":"2022-08-30T17:00:55.317Z","dependency_job_id":null,"html_url":"https://github.com/nebbles/gitcommit","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebbles%2Fgitcommit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebbles%2Fgitcommit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebbles%2Fgitcommit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebbles%2Fgitcommit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nebbles","download_url":"https://codeload.github.com/nebbles/gitcommit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244776322,"owners_count":20508506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","commitizen","commits","conventional-commits","git","gitcommit","python3","semantic-versioning"],"created_at":"2025-03-21T10:02:09.223Z","updated_at":"2025-03-21T10:02:09.715Z","avatar_url":"https://github.com/nebbles.png","language":"Python","readme":"\u003cp  align=\"center\"\u003e\n  \u003cstrong\u003egitcommit\u003c/strong\u003e\n  \u003cbr\u003e\n  \u003ccode\u003ea tool for writing conventional commits, conveniently\u003c/code\u003e\n  \u003cbr\u003e\u003cbr\u003e\n  \u003ca href=\"https://badge.fury.io/py/conventional-commit\"\u003e\u003cimg src=\"https://badge.fury.io/py/conventional-commit.svg\" alt=\"PyPI version\" height=\"18\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/nebbles/gitcommit/branches\"\u003e\u003cimg src=\"https://travis-ci.org/nebbles/gitcommit.svg?branch=master\" alt=\"Travis CI build\" height=\"18\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\" height=\"18\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Install\n\nTo install\n\n```\npip install conventional-commit\n```\n\nTo use, run the following command from within a git repository\n\n```\ngitcommit\n```\n\n# Overview\n\nThe purpose of this utility is to expedite the process of committing with a conventional message format in a user friendly way. This tool is not templated, because it sticks rigidly to the [Conventional Commit standard](https://www.conventionalcommits.org), and thus not designed to be 'altered' on a case by case basis.\n\nCommit messages produced follow the general template:\n\n```\n\u003ctype\u003e[(optional scope)]: \u003cdescription\u003e\n\n[BREAKING CHANGE: ][optional body / required if breaking change]\n\n[optional footer]\n```\n\nAdditional rules implemeted:\n\n1. Subject line (i.e. top) should be no more than 50 characters.\n2. Every other line should be no more than 72 characters.\n3. Wrapping is allowed in the body and footer, NOT in the subject.\n\n# Development\n\nThe old distribution method is documented in\n[docs/dev_distibution_legacy.md](docs/dev_distribution_legacy.md)\n\n_Note: if modifying `.travis.yml` you should verify it by running `travis lint .travis.yml`_\n\n## Getting started\n\n1. Make sure you have [pre-commit](https://pre-commit.com/#install) installed.\n\n1. Make sure you have [pyenv](https://github.com/pyenv/pyenv) installed.\n\n1. Make sure you have [Poetry](https://github.com/sdispater/poetry) installed.\n\n1. `git clone`\n\n1. `pre-commit install`\n\n1. It is highly recommend you enable setting for storing the venvs within your projects.\n\n   ```\n   poetry config virtualenvs.in-project true\n   ```\n\n1. Install project dependencies.\n   ```\n   poetry install\n   ```\n\n## Running the package locally\n\n1. Activate the virtual environment.\n\n   ```\n   source .venv/bin/activate\n   ```\n\n1. Run the package as a module.\n   ```\n   python -m gitcommit\n   ```\n\nAlternatively,\n\n1. Run the package using Poetry's venv as context\n   ```\n   poetry run python -m gitcommit\n   ```\n\nOr, if in another directory,\n\n1.  ```\n    ~/GitHub/gitcommit/.venv/bin/python -m gitcommit\n    ```\n\n## Deploy\n\nDeployment is handled automatically by Travis CI. It has been linked to the\nrepository and is automatically watching for pushes to master. It will build\nand test every commit to master. It will also build every tagged commit as\nif it was a branch, and since its a tagged commit, will attempt to publish\nit to PyPI.\n\n1. Don't forget to increment version number set in `pyproject.toml`. This can be\n   done with poetry.\n\n   ```\n   poetry version [patch|minor|major]\n   ```\n\n1. Update the version number as stored in the `gitcommit/__version__.py` file to match that designated by Poetry.\n\n1. Tag the commit (by default applies to HEAD commit - make sure you are on the latest `develop` commit).\n\n   ```\n   git tag v#.#.#\n   ```\n\n1. When pushing commits to remote, you must explicitly push tags too.\n   ```\n   git push origin --tags\n   ```\n\n## Acknowledgements\n\nThis work takes inspiration from [another repository porting Commitizen to Python](https://github.com/Woile/commitizen). This repository however uses none of the same source code and is focusing on a different approach.\n\n## License\n\nThis work is published under [GNU GPLv3](./LICENSE).\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebbles%2Fgitcommit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnebbles%2Fgitcommit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebbles%2Fgitcommit/lists"}