setuptools-github 0.2.1b43

supports github releases

This package manages the __version__ and __hash__ variables in a __init__.py file in the github actions-driven builds.

For each build in a specially named branch (eg. /beta/N.M.O) a wheel package will created with a __version__ set to N.M.Ob<build-number> to respect the order in pep440 and a __hash__ set to the git hash.

A script setuptools-github-start-release will help to start a beta release branch.

Setup

The starting point is the master branch.

First add into the setup.py:

from setuptools_github import tools
initfile = pathlib.Path(__file__).parent / "your_package/__init__.py"
version = tools.update_version(initfile, os.getenv("GITHUB_DUMP"))

setup(
     name="a-name",
     version=version,
     ...

Then insert into your_package/__init__.py:

__version__ = "0.0.0"
__hash__ = ""

The setuptools_github supports a simple but reliable way to maintain beta and release branches of a project.

The main model is rather simple, all the code gets developed on the master branch.

A branch (named beta/N.M.O) maintains all the beta releases for a particular release: each one will have a version N.M.Ob<build-no>. Finally tagging the code as release/N.M.O, will formalize the “release” for N.M.O.

Features

Usage in setup.py:

from setuptools_github import tools
initfile = pathlib.Path(__file__).parent / "your_package/__init__.py"
version = tools.update_version(initfile, os.getenv("GITHUB_DUMP"))

setup(
     name="a-name",
     version=version,
     ...

Requirements

• Python >= 3.7.

• setuptools

Installation

You can install setuptools-github via pip from PyPI:

$ pip install setuptools-github

Or conda:

$ conda install -c conda-forge setuptools-github