Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

a tool for writing conventional commits, conveniently

Project description

gitcommit
a tool for writing conventional commits, conveniently

PyPI version Travis CI build

Install

To install

pip install conventional-commit

To use, run the following command from within a git repository

gitcommit

Overview

The 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, and thus not designed to be 'altered' on a case by case basis.

Commit messages produced follow the general template:

<type>[(optional scope)]: <description>

[BREAKING CHANGE: ][optional body / required if breaking change]

[optional footer]

Additional rules implemeted:

  1. Subject line (i.e. top) should be no more than 50 characters.
  2. Every other line should be no more than 72 characters.
  3. Wrapping is allowed in the body and footer, NOT in the subject.

Development

The old distribution method is documented in docs/dev_distibution_legacy.md

Note: if modifying .travis.yml you should verify it by running travis lint .travis.yml

Getting started

  1. Make sure you have Poetry installed.

  2. Make sure you have pyenv installed.

  3. Git clone.

  4. It is highly recommend you enable setting for storing the venvs within your projects.

    poetry config settings.virtualenvs.in-project true
    
  5. Install project dependencies.

    poetry install
    

Running the package locally

  1. Activate the virtual environment.

    source .venv/bin/activate
    
  2. Run the package as a module.

    python -m gitcommit
    

Alternatively,

  1. Run the package using Poetry's venv as context
    poetry run python -m gitcommit
    

Deploy

Deployment is handled automatically by Travis CI. It has been linked to the repository and is automatically watching for pushes to master. It will build and test every commit to master. It will also build every tagged commit as if it was a branch, and since its a tagged commit, will attempt to publish it to PyPI.

  1. Don't forget to increment version number set in pyproject.toml. This can be done with poetry.

    poetry version [patch|minor|major]
    
  2. Tag the commit (by default applies to HEAD commit).

    git tag v#.#.#
    
  3. When pushing commits to remote, you must explicitly push tags too.

    git push origin --tags
    

Acknowledgements

This work takes heavy influence from another repository porting Commitizen to Python.

License

This work is published under GNU GPLv3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for conventional-commit, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size conventional_commit-0.2.2-py3-none-any.whl (23.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size conventional-commit-0.2.2.tar.gz (22.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page