diff --git a/.gitignore b/.gitignore index b057de5..79559be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,12 @@ /.cache/ /.tox/ +*.egg-info/ +Pipfile +*.pyc +*.pya +build/ +*__pycache__* +*.eggs/ +*.swa +*.swp +*~ diff --git a/README.rst b/README.rst index 95da5ac..42c09ef 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,14 @@ setuptools-git-version *Automatically set package version from Git.* +Install +------- + +Install ``setuptools-git-version`` from pypi: + +.. code-block:: shell + pip install setuptools-git-version + Introduction ------------ @@ -29,6 +37,13 @@ this package allows to extract it from the underlying Git repository: Please ensure that your git repository has at least one `annotated tag `_, as ``setuptools-git-version`` will uses tags to determine your current git version. +Also you can use ``setuptools-git-version`` as a CLI command to retrieve the version like this: + +.. code-block:: shell + $ # go to your project directory + $ setuptools-git-version + 1.0.4.5+b1afbd9 + Fields ------ ``setuptools-git-version`` provides three fields as options for the ``version_format`` string: