You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

110 lines
4.7 KiB

4 years ago
  1. Incremental
  2. ===========
  3. |travis|
  4. |pypi|
  5. |coverage|
  6. Incremental is a small library that versions your Python projects.
  7. API documentation can be found `here <https://hawkowl.github.io/incremental/docs/>`_.
  8. Quick Start
  9. -----------
  10. Add this to your ``setup.py``\ 's ``setup()`` call, removing any other versioning arguments:
  11. .. code::
  12. setup(
  13. use_incremental=True,
  14. setup_requires=['incremental'],
  15. install_requires=['incremental'], # along with any other install dependencies
  16. ...
  17. }
  18. Then run ``python -m incremental.update <projectname> --create`` (you will need ``click`` installed from PyPI).
  19. It will create a file in your package named ``_version.py`` and look like this:
  20. .. code::
  21. from incremental import Version
  22. __version__ = Version("widgetbox", 17, 1, 0)
  23. __all__ = ["__version__"]
  24. Then, so users of your project can find your version, in your root package's ``__init__.py`` add:
  25. .. code::
  26. from ._version import __version__
  27. Subsequent installations of your project will then use Incremental for versioning.
  28. Incremental Versions
  29. --------------------
  30. ``incremental.Version`` is a class that represents a version of a given project.
  31. It is made up of the following elements (which are given during instantiation):
  32. - ``package`` (required), the name of the package this ``Version`` represents.
  33. - ``major``, ``minor``, ``micro`` (all required), the X.Y.Z of your project's ``Version``.
  34. - ``release_candidate`` (optional), set to 0 or higher to mark this ``Version`` being of a release candidate (also sometimes called a "prerelease").
  35. - ``dev`` (optional), set to 0 or higher to mark this ``Version`` as a development release.
  36. You can extract a PEP-440 compatible version string by using the following methods:
  37. - ``.local()``, which returns a ``str`` containing the full version plus any Git or SVN information, if available. An example output would be ``"17.1.1rc1+r123"`` or ``"3.7.0+rb2e812003b5d5fcf08efd1dffed6afa98d44ac8c"``.
  38. - ``.public()``, which returns a ``str`` containing the full version, without any Git or SVN information. This is the version you should provide to users, or publicly use. An example output would be ``"13.2.0"``, ``"17.1.2dev1"``, or ``"18.8.0rc2"``.
  39. Calling ``repr()`` with a ``Version`` will give a Python-source-code representation of it, and calling ``str()`` with a ``Version`` will provide a string similar to ``'[Incremental, version 16.10.1]'``.
  40. Updating
  41. --------
  42. Incremental includes a tool to automate updating your Incremental-using project's version called ``incremental.update``.
  43. It updates the ``_version.py`` file and automatically updates some uses of Incremental versions from an indeterminate version to the current one.
  44. It requires ``click`` from PyPI.
  45. ``python -m incremental.update <projectname>`` will perform updates on that package.
  46. The commands that can be given after that will determine what the next version is.
  47. - ``--newversion=<version>``, to set the project version to a fully-specified version (like 1.2.3, or 17.1.0dev1).
  48. - ``--rc``, to set the project version to ``<year-2000>.<month>.0rc1`` if the current version is not a release candidate, or bump the release candidate number by 1 if it is.
  49. - ``--dev``, to set the project development release number to 0 if it is not a development release, or bump the development release number by 1 if it is.
  50. - ``--patch``, to increment the patch number of the release. This will also reset the release candidate number, pass ``--rc`` at the same time to increment the patch number and make it a release candidate.
  51. If you give no arguments, it will strip the release candidate number, making it a "full release".
  52. Incremental supports "indeterminate" versions, as a stand-in for the next "full" version. This can be used when the version which will be displayed to the end-user is unknown (for example "introduced in" or "deprecated in"). Incremental supports the following indeterminate versions:
  53. - ``Version("<projectname>", "NEXT", 0, 0)``
  54. - ``<projectname> NEXT``
  55. When you run ``python -m incremental.update <projectname> --rc``, these will be updated to real versions (assuming the target final version is 17.1.0):
  56. - ``Version("<projectname>", 17, 1, 0, release_candidate=1)``
  57. - ``<projectname> 17.1.0rc1``
  58. Once the final version is made, it will become:
  59. - ``Version("<projectname>", 17, 1, 0)``
  60. - ``<projectname> 17.1.0``
  61. .. |coverage| image:: https://codecov.io/github/hawkowl/incremental/coverage.svg?branch=master
  62. .. _coverage: https://codecov.io/github/hawkowl/incremental
  63. .. |travis| image:: https://travis-ci.org/hawkowl/incremental.svg?branch=master
  64. .. _travis: http://travis-ci.org/hawkowl/incremental
  65. .. |pypi| image:: http://img.shields.io/pypi/v/incremental.svg
  66. .. _pypi: https://pypi.python.org/pypi/incremental