Skip to content

Some minor improvements #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Some minor improvements #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16d19ac
Adding some gitignore rules
4383 May 13, 2019
355f7c5
Update documentation with install and cli use
4383 May 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
/.cache/
/.tox/
*.egg-info/
Pipfile
*.pyc
*.pya
build/
*__pycache__*
*.eggs/
*.swa
*.swp
*~
15 changes: 15 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand All @@ -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 <https://git-scm.com/book/en/v2/Git-Basics-Tagging>`_,
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:
Expand Down