Version
========

``_version`` is generated by setuptools-scm

Before changing the version (build / kitting), activate the virtual environment

Development versions
---------------------

For **development builds** (micro; non-tagged), before a commit

Update the ``_version`` file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: shell

   python igor.py version "current"

Build / kitting (dev)
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: shell

   python igor.py build_next ""

Tagged versions
----------------

To create a new minor or major version, both within source repository
**AND** virtual environment code, manually edited ``_version``

Build / kitting (tagged)
~~~~~~~~~~~~~~~~~~~~~~~~~

(e.g. a minor version 0.3.0)

.. code-block:: shell

   python igor.py build_next "0.3.0"

After build/kitting, commit and release branch merge occurs, then the
commit is tagged. Follow workflow in howto.txt

Install
--------

.. code-block:: shell

   make install force=1

**Module private variables**

.. py:data:: __version__
   :type: str

   Current version as a str

.. py:data:: __version_tuple__
   :type: tuple[int | str, ...]

   Current version as a tuple. fields: major, minor, micro, [pre|post] release, local