Skip to main content

Setuptools helper functions

Project description


Helper functions for writing’s.

Build Status Coverage Status Version Download format Downloads this month Development Status License

Helper functions

setuphelpers provides the following:


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", "")
if os.path.isfile(VER_FILE):
    # this should only be run during rebuilding a sdist package
    VERSION = find_version(VER_FILE)
    # this should be run only during the actual packaging
    VERSION = git_version()
    with, "w", encoding="utf-8") as openversion:
        openversion.write('__version__ = "{}"'.format(VERSION))

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


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

from setuptools import setup
from setuphelpers import long_description

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


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/"))


Used to build a test command class for running unit tests with python 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

    tests_require=["pytest", "pytest-cov"],

A note on setup_requires

You can (and should) put setuphelpers in the setup_requires argument of your But you also need to be careful to avoid dependency problems during build. To accomplish this, you can use this pattern (for each/any of the used functions):

from setuptools import setup
    from setuphelpers import (
        find_version,  # not used, but for completeness
except ImportError:
    find_version = lambda x: "0.0.0"
    git_version = lambda: "0.0.0"
    long_description = lambda: __doc__
    test_command = lambda **_: {}

    version=git_version(),  # find_version("my_thing/"),
    tests_require=["pytest", "pytest-cov"],

Now python install should pull in setuphelpers if it’s missing, and re-exec itself to fill in the arguments as expected. You need to manually avoid both the ImportError and the NameError though, so mock callables need to be created in the case of missing setuphelpers.

Project details

Download files

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

Built Distribution

setuphelpers-0.1.2-py2.py3-none-any.whl (10.3 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page