setuphelpers 0.1.2

git_version

Use to supply your package’s version string from git. If the latest commit is tagged, the version will be that tag. If it is not tagged, it will be the last version + 1 minor/patch version .devN number of commits since last tag. If building off a branch other than master, the branch name is used as a local version identifier.

Examples: 0.0.1, 0.0.2.dev1, 0.0.2.dev1+featureX

from setuptools import setup
from setuphelpers import git_version

setup(name="my_thing", version=git_version())

Note that you cannot deploy a sdist package using git_version, due to needing access to .git. But please don’t start including .git’s in your packages. There is a pattern you can use to have git_version write out to a file to include, but I would argue that there’s not a need to do that, as it’s already included in the written package metadata anyway (wheels > *). But if you must:

import os
import io
from setuptools import setup
from setuphelpers import git_version
from setuphelpers import find_version

# VER_FILE should not exist in your checked in source
VER_FILE = os.path.join("my_thing", "__version__.py")
if os.path.isfile(VER_FILE):
    # this should only be run during rebuilding a sdist package
    VERSION = find_version(VER_FILE)
else:
    # this should be run only during the actual packaging
    VERSION = git_version()
    with io.open(VER_FILE, "w", encoding="utf-8") as openversion:
        openversion.write('__version__ = "{}"'.format(VERSION))

setup(name="my_thing", version=VERSION)

long_description

Use to fill in the long_description field with the contents of your README. If no README is found, will fallback to the docstring of your setup.py.

from setuptools import setup
from setuphelpers import long_description

setup(name="my_thing", version="1.0", long_description=long_description())

find_version

Used to find the value assigned to __version__ in the specified filepath.

from setuptools import setup
from setuphelpers import find_version

setup(name="my_thing", version=find_version("my_thing/__init__.py"))

test_command

Used to build a test command class for running unit tests with python setup.py test. Default support is for py.test, but nose and unittest are also both possible. The return from test_command can be passed to cmdclass.

Note that the tests_require dependancies still need to be provided, including coverage, if you’re using it (plus whatever else you need to test with).

from setuptools import setup
from setuphelpers import test_command

setup(
    name="my_thing",
    version="1.0",
    tests_require=["pytest", "pytest-cov"],
    cmdclass=test_command(cover="my_thing"),
)