Skip to main content
Travis AppVeyor Coverage Updates PyPI

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__

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setuptools_scm_about-1.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

setuptools_scm_about-1.0-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file setuptools_scm_about-1.0.tar.gz.

File metadata

File hashes

Hashes for setuptools_scm_about-1.0.tar.gz
Algorithm Hash digest
SHA256 3a8a6c93b0d035f782d0cee21f0dd8b0e64b28b22f2e95c1c61a6d85309b10ae
MD5 faca11c943f52f633be192eaaea604b5
BLAKE2b-256 caaad2688ae2671118552ef0cebd13fa7ad84ec715d1e96d6207b11361c78642

See more details on using hashes here.

File details

Details for the file setuptools_scm_about-1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for setuptools_scm_about-1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e707db1cd2ae12579eb7b1589d2b076fd392e77669222e662597e6236ae1160c
MD5 4487185b0ba8b145d01f048389c50076
BLAKE2b-256 4463893b155756cf80eabc2f3193e706ddd7f62d7b25709376da0904f6622ac2

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page