:py:mod:`sovabids._version`
===========================

.. py:module:: sovabids._version

.. autoapi-nested-parse::

   Git implementation of _version.py.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   sovabids._version.VersioneerConfig



Functions
~~~~~~~~~

.. autoapisummary::

   sovabids._version.get_keywords
   sovabids._version.get_config
   sovabids._version.register_vcs_handler
   sovabids._version.run_command
   sovabids._version.versions_from_parentdir
   sovabids._version.git_get_keywords
   sovabids._version.git_versions_from_keywords
   sovabids._version.git_pieces_from_vcs
   sovabids._version.plus_or_dot
   sovabids._version.render_pep440
   sovabids._version.render_pep440_branch
   sovabids._version.render_pep440_pre
   sovabids._version.render_pep440_post
   sovabids._version.render_pep440_post_branch
   sovabids._version.render_pep440_old
   sovabids._version.render_git_describe
   sovabids._version.render_git_describe_long
   sovabids._version.render
   sovabids._version.get_versions



Attributes
~~~~~~~~~~

.. autoapisummary::

   sovabids._version.LONG_VERSION_PY
   sovabids._version.HANDLERS


.. py:function:: get_keywords()

   Get the keywords needed to look up the version information.


.. py:class:: VersioneerConfig


   Container for Versioneer configuration parameters.


.. py:function:: get_config()

   Create, populate and return the VersioneerConfig() object.


.. py:exception:: NotThisMethod


   Bases: :py:obj:`Exception`

   Exception raised if a method is not valid for the current scenario.


.. py:data:: LONG_VERSION_PY

   

.. py:data:: HANDLERS

   

.. py:function:: register_vcs_handler(vcs, method)

   Create decorator to mark a method as the handler of a VCS.


.. py:function:: run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None)

   Call the given command(s).


.. py:function:: versions_from_parentdir(parentdir_prefix, root, verbose)

   Try to determine the version from the parent directory name.

   Source tarballs conventionally unpack into a directory that includes both
   the project name and a version string. We will also support searching up
   two directory levels for an appropriately named parent directory


.. py:function:: git_get_keywords(versionfile_abs)

   Extract version information from the given file.


.. py:function:: git_versions_from_keywords(keywords, tag_prefix, verbose)

   Get version information from git keywords.


.. py:function:: git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command)

   Get version from 'git describe' in the root of the source tree.

   This only gets called if the git-archive 'subst' keywords were *not*
   expanded, and _version.py hasn't already been rewritten with a short
   version string, meaning we're inside a checked out source tree.


.. py:function:: plus_or_dot(pieces)

   Return a + if we don't already have one, else return a .


.. py:function:: render_pep440(pieces)

   Build up version string, with post-release "local version identifier".

   Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
   get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty

   Exceptions:
   1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]


.. py:function:: render_pep440_branch(pieces)

   TAG[[.dev0]+DISTANCE.gHEX[.dirty]] .

   The ".dev0" means not master branch. Note that .dev0 sorts backwards
   (a feature branch will appear "older" than the master branch).

   Exceptions:
   1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty]


.. py:function:: render_pep440_pre(pieces)

   TAG[.post0.devDISTANCE] -- No -dirty.

   Exceptions:
   1: no tags. 0.post0.devDISTANCE


.. py:function:: render_pep440_post(pieces)

   TAG[.postDISTANCE[.dev0]+gHEX] .

   The ".dev0" means dirty. Note that .dev0 sorts backwards
   (a dirty tree will appear "older" than the corresponding clean one),
   but you shouldn't be releasing software with -dirty anyways.

   Exceptions:
   1: no tags. 0.postDISTANCE[.dev0]


.. py:function:: render_pep440_post_branch(pieces)

   TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] .

   The ".dev0" means not master branch.

   Exceptions:
   1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty]


.. py:function:: render_pep440_old(pieces)

   TAG[.postDISTANCE[.dev0]] .

   The ".dev0" means dirty.

   Exceptions:
   1: no tags. 0.postDISTANCE[.dev0]


.. py:function:: render_git_describe(pieces)

   TAG[-DISTANCE-gHEX][-dirty].

   Like 'git describe --tags --dirty --always'.

   Exceptions:
   1: no tags. HEX[-dirty]  (note: no 'g' prefix)


.. py:function:: render_git_describe_long(pieces)

   TAG-DISTANCE-gHEX[-dirty].

   Like 'git describe --tags --dirty --always -long'.
   The distance/hash is unconditional.

   Exceptions:
   1: no tags. HEX[-dirty]  (note: no 'g' prefix)


.. py:function:: render(pieces, style)

   Render the given version pieces into the requested style.


.. py:function:: get_versions()

   Get version information or return default if unable to do so.