Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jnrowe/versionah

Tool for mangling version data in projects
https://github.com/jnrowe/versionah

python release terminal tools version

Last synced: 5 days ago
JSON representation

Tool for mangling version data in projects

Awesome Lists containing this project

README 

        
``versionah`` - Simple version specification management

=======================================================



|status| |travis| |coveralls| |pypi| |pyvers| |readthedocs| |develop|



Introduction

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



``versionah`` is a simple tool to help you — or more specifically *me* — easily

maintain version information for a project.  Its entire aim is to make the act

of displaying or bumping a project’s version number a thoughtless task.



It is written in Python, and released under the `GPL v3`_.



Requirements

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



``versionah`` should run on Python_ v3.5 or newer.  The only external libraries

``versionah`` depends on are click_, jinja_ and jnrbase_.  If ``versionah``

doesn’t work with the version of Python you have installed, file an issue_ and

I’ll endeavour to fix it.



Example

-------



The simplest way to show how ``versionah`` works is by example:



.. code-block:: console



    $ versionah set example.txt 2.4.3

    2.4.3

    $ versionah display example.txt

    2.4.3

    $ versionah bump example.txt minor

    2.5.0

    $ versionah bump example.txt major

    3.0.0



API Stability

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



API stability isn’t guaranteed across versions, although frivolous changes won’t

be made.



When ``versionah`` 1.0.0 is released the API will be frozen, and any changes

which aren’t backwards compatible will force a major version bump.



Contributors

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



I’d like to thank the following people who have contributed to ``versionah``.



Patches

'''''''



* Marc Abramowitz

* Ansel Cloutier

* TakesxiSximada



Bug reports

'''''''''''



* Leal Hétu

* Matt Leighy



Ideas

'''''



* Ryan Lewis

* Ryan Sutton



If I’ve forgotten to include your name I wholeheartedly apologise.  Just drop me

a mail_ and I’ll update the list!



Bugs

----



If you find any problems, bugs or just have a question about this package either

file an issue_ or drop me a mail_.



If you’ve found a bug please try to include a minimal testcase so I can

reproduce the problem, or even better a patch!



.. _GPL v3: http://www.gnu.org/licenses/

.. _Python: http://www.python.org/

.. _click: http://click.pocoo.org/

.. _jinja: http://jinja.pocoo.org/

.. _jnrbase: https://pypi.python.org/pypi/jnrbase/

.. _mail: [email protected]

.. _issue: https://github.com/JNRowe/versionah/issues/



.. |travis| image:: https://secure.travis-ci.org/JNRowe/versionah.png?branch=master

   :target: https://travis-ci.org/JNRowe/versionah

   :alt: Test state on master



.. |develop| image:: https://img.shields.io/github/commits-since/JNRowe/versionah/latest.png

   :target: https://github.com/JNRowe/versionah

   :alt: Recent developments



.. |pyvers| image:: https://img.shields.io/pypi/pyversions/versionah.png

   :alt: Supported Python versions



.. |status| image:: https://img.shields.io/pypi/status/versionah.png

   :alt: Development status



.. |coveralls| image:: https://img.shields.io/coveralls/github/JNRowe/versionah/master.png

   :target: https://coveralls.io/github/repos/JNRowe/versionah

   :alt: Coverage state on master



.. |pypi| image:: https://img.shields.io/pypi/v/jnrbase.png

   :target: https://pypi.python.org/pypi/jnrbase

   :alt: Current PyPI release



.. |readthedocs| image:: https://img.shields.io/readthedocs/versionah/stable.png

   :target: https://versionah.readthedocs.io/

   :alt: Documentation