pip-shims 0.3.0

Compatibility shims for pip versions 8 thru current.

Warning

Warning

The authors of pip do not condone the use of this package. Relying on pip’s internals is a dangerous idea for your software as they are broken intentionally and regularly. This package may not always be completely updated up PyPI, so relying on it may break your code! User beware!

Installation

Install from PyPI:

$ pipenv install --pre pip-shims

Install from Github:

$ pipenv install -e git+https://github.com/sarugaku/pip-shims.git#egg=pip-shims

Summary

pip-shims is a set of compatibilty access shims to the pip internal API. pip-shims provides compatibility with pip versions 8.0 through the current release (18.x). The shims are provided using a lazy import strategy (powered by modutil where possible, falling back to importlib from the standard library with a lazy import strategy otherwise). This library exists due to my constant writing of the same set of import shims across many different libraries, including pipenv, pip-tools, requirementslib, and passa.

Usage

Importing a shim

You can use pip-shims to expose elements of pip’s internal API by importing them:

from pip_shims import Wheel
mywheel = Wheel('/path/to/my/wheel.whl')

Available Shims

pip-shims provides the following compatibility shims:

Import Path	Import Name	Former Path
req.constructors	_strip_extras	req.req_install
cli	cmdoptions	cmdoptions
cli.base_command	Command	basecommand
cli.parser	ConfigOptionParser	baseparser
exceptions	DistributionNotFound
utils.hashes	FAVORITE_HASH
models	FormatControl	index
utils.misc	get_installed_distributions	utils
cli.cmdoptions	index_group	cmdoptions
req.req_install	InstallRequirement
req.constructors	install_req_from_line	req.req_install.InstallRequirement
req.constructors	install_req_from_editable	req.req_install.InstallRequirement
req.req_uninstall	UninstallPathSet
download	is_archive_file
download	is_file_url
utils.misc	is_installable_dir	utils
index	Link
operations.prepare	make_abstract_dist	req.req_set
cli.cmdoptions	make_option_group	cmdoptions
index	PackageFinder
req.req_file	parse_requirements
index	parse_version
download	path_to_url
__version__	pip_version
exceptions	PipError
operations.prepare	RequirementPreparer
operations.freeze	FrozenRequirement	<__init__>
req.req_set	RequirementSet
req.req_tracker	RequirementTracker
resolve	Resolver
download	SafeFileCache
download	url_to_path
download	unpack_url
locations	USER_CACHE_DIR
vcs	VcsSupport
wheel	Wheel
wheel	WheelBuilder
cache	WheelCache	wheel