https://github.com/greatfruitomsk/setuptools_scm_about

setuptools_scm plugin to use version from __about__.py
https://github.com/greatfruitomsk/setuptools_scm_about

python setuptools setuptools-scm

Last synced: 5 months ago
JSON representation

setuptools_scm plugin to use version from __about__.py

• Host: GitHub
• URL: https://github.com/greatfruitomsk/setuptools_scm_about
• Owner: GreatFruitOmsk
• License: mit
• Created: 2017-12-15T17:58:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-15T22:24:43.000Z (over 7 years ago)
• Last Synced: 2025-01-30T11:36:42.665Z (6 months ago)
• Topics: python, setuptools, setuptools-scm
• Language: Python
• Size: 5.86 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://travis-ci.org/GreatFruitOmsk/setuptools_scm_about.svg?branch=master

    :target: https://travis-ci.org/GreatFruitOmsk/setuptools_scm_about

    :alt: Travis

.. image:: https://ci.appveyor.com/api/projects/status/abqxn2vbk5k2styb/branch/master?svg=true

    :target: https://ci.appveyor.com/project/GreatFruitOmsk/setuptools_scm_about-app

    :alt: AppVeyor

.. image:: https://codecov.io/gh/GreatFruitOmsk/setuptools_scm_about/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/GreatFruitOmsk/setuptools_scm_about

    :alt: Coverage

.. image:: https://pyup.io/repos/github/GreatFruitOmsk/setuptools_scm_about/shield.svg

    :target: https://pyup.io/repos/github/GreatFruitOmsk/setuptools_scm_about/

    :alt: Updates

.. image:: https://img.shields.io/pypi/v/setuptools_scm_about.svg

    :target: https://pypi.python.org/pypi/setuptools_scm_about

    :alt: 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:

.. code:: python

    setup(

        ...,

        use_scm_version={

            'write_to': 'myproject/_version.py'

        },

        setup_requires=['setuptools_scm', 'setuptools_scm_about'],

        ...,

    )

Define ``__version__`` in ``myproject/__about__.py``:

.. code:: python

    __version__ = 1.0

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

.. code:: python

    try:

        from ._version import version as __version__

    except ImportError:

        from .__about__ import __version__