This is a setuptools_scm plugin that adds support for __about__.py files.

If version cannot be resolved via SCM, the fallback registered by this plugin will be called. It will try to find the __about__.py file (using the **/__about__.py glob pattern) that defines the __version__ variable.

Since there is no SCM metadata available, package will return VERSION.dev0+unknown where VERSION is a version from __about__.py.

Usage

Add 'setuptools_scm_about' to the setup_requires parameter in your project's setup.py file:

setup(
    ...,
    use_scm_version={
        'write_to': 'myproject/_version.py'
    },
    setup_requires=['setuptools_scm', 'setuptools_scm_about'],
    ...,
)

Define __version__ in myproject/__about__.py:

__version__ = 1.0

Import __version__ in myproject/__init__.py for external access:

try:
    from ._version import version as __version__
except ImportError:
    from .__about__ import __version__