Skip to main content

Setuptools plugin for finding files under Mercurial version control.

Project description

setuptools_hg is a plugin for setuptools that enables setuptools to find files under the Mercurial version control system.

It uses the Mercurial Python library by default and falls back to use the command line programm hg(1). That’s especially useful inside virtualenvs that don’t have access to the system wide installed Mercurial lib (e.g. when created with --no-site-packages).

Usage

Here’s an example of a setup.py that uses setuptools_hg:

from setuptools import setup, find_packages
setup(
    name="HelloWorld",
    version="0.1",
    packages=find_packages(),
    setup_requires=["setuptools_hg"],
)

If you run this setup.py setuptools will automatically download setuptools_hg to the directory where the setup.py is located at (and won’t install it anywhere else) to get all package data files from the Mercurial repository.

Options

Set the HG_SETUPTOOLS_FORCE_CMD environment variable before running setup.py if you want to enforce the use of the hg command.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page