https://github.com/pycontribs/pyversion
Python package versioning made simple
https://github.com/pycontribs/pyversion
Last synced: about 1 year ago
JSON representation
Python package versioning made simple
- Host: GitHub
- URL: https://github.com/pycontribs/pyversion
- Owner: pycontribs
- License: mit
- Created: 2014-10-01T17:21:41.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T06:18:31.000Z (about 2 years ago)
- Last Synced: 2024-12-06T21:31:43.237Z (over 1 year ago)
- Language: Python
- Size: 184 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 46
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Python Version Library
======================
.. image:: https://badge.fury.io/py/pyversion.svg
:target: https://badge.fury.io/py/pyversion
:alt: Current Version
.. image:: https://travis-ci.org/pycontribs/pyversion.svg
:target: https://travis-ci.org/pycontribs/pyversion
:alt: Build Status
.. image:: https://coveralls.io/repos/github/pycontribs/pyversion/badge.svg?branch=master
:target: https://coveralls.io/github/pycontribs/pyversion?branch=master
:alt: Coverage
.. image:: https://requires.io/github/pycontribs/pyversion/requirements.svg?branch=master
:target: https://requires.io/github/pycontribs/pyversion/requirements/?branch=master
:alt: Requirements Status
.. image:: https://snyk.io/test/github/pycontribs/pyversion/badge.svg?targetFile=requirements.txt
:target: https://snyk.io/test/github/pycontribs/pyversion/badge.svg?targetFile=requirements.txt
:alt: Vulnerabililtes Status
.. image:: https://pyup.io/repos/github/pycontribs/pyversion/shield.svg
:target: https://pyup.io/repos/github/pycontribs/pyversion/
:alt: Updates
.. image:: https://pyup.io/repos/github/pycontribs/pyversion/python-3-shield.svg
:target: https://pyup.io/repos/github/pycontribs/pyversion/
:alt: Python 3
Python package versioning made simple
NOTE: this is a fork of the original rocktavious/pyversion. This version has been upgraded to support python3.x
Quickstart
----------
Feeling impatient? I like your style.
In your setup.py file
.. code-block:: python
setup(
...
setup_requires = ['pyversion'],
auto_version = True,
...
)
On the command line
.. code-block:: python
python setup.py increment tag register sdist upload
PBR
---
If you are also using the openstack PBR package pyversion supports this as well
just modify your setup.py file
.. code-block:: python
setup(
setup_requires = [
'pbr',
'pyversion'
],
pbr = True,
auto_version = "PBR",
)
Installation
------------
Download and install using `pip install pyversion`
CLI
---
The package also comes with a cli command that can be used to determine what
the current version the package sees for your package
usage:
.. code-block:: bash
>>> pyversion
1.2.3
Developing
----------
To develop on this project, please take a fork of then and submit a pull requeest once changes are ready.
This package makes of of pipenv for installing and dependency maintainence.
If publishing to pypi, rememeber to update requirements.txt and test-requirements.txt as follows:
pipenv install --dev -ignore-pipfile > requirements.txt
pipenv lock --requirements > requirements.txt
Also remember to run tox in the base directory to run black, linter and other tests.
You can also run `tox` to perform black formatting, linting and testing.
To test build and upload to test.pypi.org use:
`tox -e testrelease`
To build and upload to production use:
`tox -e release` will release to pypi a new version
Travis is in use for CI, so you can also run: `travis-lint .travis.yml`
Or use the below to manully upload:
`python setup.py sdist bdist_wheel
twine upload dist/*`