Metadata-Version: 2.1
Name: commitizen
Version: 1.10.2
Summary: Python commitizen client tool
Home-page: https://github.com/woile/commitizen
License: MIT
Keywords: commitizen,conventional,commits,git
Author: Santiago Fraire
Author-email: santiwilly@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Dist: colorama (>=0.4.1,<0.5.0)
Requires-Dist: decli (>=0.5.0,<0.6.0)
Requires-Dist: jinja2 (>=2.10.3,<3.0.0)
Requires-Dist: packaging (>=19.0,<20.0)
Requires-Dist: questionary (>=1.4.0,<2.0.0)
Requires-Dist: termcolor (>=1.1,<2.0)
Requires-Dist: tomlkit (>=0.5.3,<0.6.0)
Description-Content-Type: text/x-rst

=============
Commitizen
=============

    Python 3 command line utility to standardize commit messages and bump version


.. image:: https://github.com/Woile/commitizen/workflows/Python%20package/badge.svg
    :alt: Github Actions
    :target: https://github.com/Woile/commitizen/actions

.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square
    :alt: Conventional Commits
    :target: https://conventionalcommits.org

.. image:: https://img.shields.io/pypi/v/commitizen.svg?style=flat-square
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/commitizen/

..  image:: https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square
    :alt: Supported versions
    :target: https://pypi.org/project/commitizen/

.. image:: https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square
    :alt: Codecov
    :target: https://codecov.io/gh/Woile/commitizen

.. image:: docs/images/demo.gif
    :alt: Example running commitizen

--------------

**Documentation**: https://Woile.github.io/commitizen/

--------------

.. contents::
    :depth: 2


About
==========

Commitizen is a tool designed for teams.

Its main purpose is to define a standard way of commiting rules
and communicating it (using the cli provided by commitizen).

The reasoning behind it is that is easier to read, and enforces writing
descriptive commits.

Besides that, having a convention on your commits, makes it possible to
parse them and use them for something else, like generating automatically
the version or a changelog.


Installation
=============

::

    pip install -U commitizen

::

    poetry add commitizen --dev


**Global installation**

::

    sudo pip3 install -U commitizen

Features
========

- Command line utility to create commits with your rules. Defaults: `conventional commits`_
- Display information about your commit rules (commands: schema, example, info)
- Bump version automatically using semantic verisoning based on the commits. `Read More <./docs/bump.md>`_
- Generate a changelog using "Keep a changelog" (Planned feature)


Commit rules
============

This client tool prompts the user with information about the commit.

Based on `conventional commits`_

This is an example of how the git messages history would look like:

::

    fix: minor typos in code
    feat: new command update
    docs: improved commitizens tab in readme
    feat(cz): jira smart commits
    refactor(cli): renamed all to ls command
    feat: info command for angular
    docs(README): added badges
    docs(README): added about, installation, creating, etc
    feat(config): new loads from ~/.cz and working project .cz .cz.cfg and setup.cfg

And then using ``cz bump`` you can change the version of your project

``feat`` to ``MINOR``
``fix`` to ``PATCH``


Commitizens
===========

These are the available commiting styles by default:

* cz_conventional_commits: `conventional commits`_
* cz_jira: `jira smart commits <https://confluence.atlassian.com/fisheye/using-smart-commits-298976812.html>`_


The installed ones can be checked with:

::

    cz ls



Commiting
=========

Run in your terminal

::

    cz commit

or the shortcut

::

    cz c


Usage
=====

::

    $ cz --help
    usage: cz [-h] [--debug] [-n NAME] [--version]
            {ls,commit,c,example,info,schema,bump} ...

    Commitizen is a cli tool to generate conventional commits.
    For more information about the topic go to https://conventionalcommits.org/

    optional arguments:
    -h, --help            show this help message and exit
    --debug               use debug mode
    -n NAME, --name NAME  use the given commitizen
    --version             get the version of the installed commitizen

    commands:
    {ls,commit,c,example,info,schema,bump,check}
        ls                  show available commitizens
        commit (c)          create new commit
        example             show commit example
        info                show information about the cz
        schema              show commit schema
        bump                bump semantic version based on the git log
        check               enforce the project to always use conventional commits

Contributing
============

Feel free to create a PR.

1. Clone the repo.
2. Add your modifications
3. Create a virtualenv
4. Run :code:`./scripts/test`


.. _conventional commits: https://conventionalcommits.org/

