.. chronos documentation master file, created by
   sphinx-quickstart on Wed Nov 14 21:35:30 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to chronos's documentation!
===================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. image:: https://img.shields.io/pypi/v/chronos-cli.svg
    :target: https://pypi.python.org/pypi/chronos-cli
    :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/chronos-cli.svg
    :target: https://pypi.python.org/pypi/chronos-cli
    :alt: PyPI Python Versions

.. image:: https://gitlab.com/claude-leveille/chronos/badges/master/pipeline.svg
    :target: https://gitlab.com/claude-leveille/chronos/commits/master
    :alt: GitLab CI Pipeline Status

.. image:: https://readthedocs.org/projects/chronos-cli/badge/?version=latest
    :target: https://chronos-cli.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://sonarcloud.io/api/project_badges/measure?project=claude-leveille_chronos&metric=alert_status
    :alt: SonarCloud Quality Gate Status

.. image:: https://sonarcloud.io/api/project_badges/measure?project=claude-leveille_chronos&metric=coverage
    :alt: SonarCloud Test Coverage

.. image:: https://sonarcloud.io/api/project_badges/measure?project=claude-leveille_chronos&metric=bugs
    :alt: SonarCloud Bugs

.. image:: https://sonarcloud.io/api/project_badges/measure?project=claude-leveille_chronos&metric=reliability_rating
    :alt: SonarCloud Bugs


.. _semver: https://semver.org
.. _Conventional Commits: https://conventionalcommits.org

A CLI tool that infers a next version number for Git repos. It does its magic by looking at the commit messages of commits made since the last tag that had a semver_ in it. For this to work properly, your commits should following the `Conventional Commits`_ spec.

Getting started
===============

**Requires Git 2.0+.**

To use the tool:

- ``pip install --upgrade chronos-cli``
- Change into a Git repo.
- ``chronos infer``

To bootstrap a development environment (after you've cloned the repo and changed into it):

- ``pip install --upgrade pipenv``
- ``pipenv sync --dev``

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`