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__

Metadata

Release files for setuptools-scm-about 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for setuptools-scm-about 1.0
File Size Uploaded
setuptools_scm_about-1.0.tar.gz 5.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for setuptools-scm-about 1.0
File Interpreter ABI Platform
setuptools_scm_about-1.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 10.6 kB

Release files / setuptools_scm_about-1.0.tar.gz

Download URL setuptools_scm_about-1.0.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3a8a6c93b0d035f782d0cee21f0dd8b0e64b28b22f2e95c1c61a6d85309b10ae
BLAKE2b-256 checksum
How to use checksums
caaad2688ae2671118552ef0cebd13fa7ad84ec715d1e96d6207b11361c78642
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / setuptools_scm_about-1.0-py2.py3-none-any.whl

Download URL setuptools_scm_about-1.0-py2.py3-none-any.whl
Size 5.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
e707db1cd2ae12579eb7b1589d2b076fd392e77669222e662597e6236ae1160c
BLAKE2b-256 checksum
How to use checksums
4463893b155756cf80eabc2f3193e706ddd7f62d7b25709376da0904f6622ac2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page