You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jon Dufresne 529efb1e97
Remove redundant --all-files argument (#44)
2 months ago
.github/workflows Run tests in verbose mode on CI 2 years ago
src/vendoring Pacify linters 12 months ago
tests Let exceptions propagate in tests 12 months ago
.flake8 Checkin initial version 3 years ago
.gitignore Significantly improve testing setup 3 years ago
.isort.cfg Checkin initial version 3 years ago
.pre-commit-config.yaml Add prettier as a linter 2 years ago
CONTRIBUTING.md Make prettier happy 2 years ago
LICENSE Checkin initial version 3 years ago
README.md Clarify that there's no stability promises 1 year ago
mypy.ini better mypy config 3 years ago
noxfile.py Remove redundant --all-files argument (#44) 2 months ago
pyproject.toml Modernise packaging 12 months ago

README.md

vendoring

A command line tool, to simplify vendoring pure Python dependencies.

Why does this exist?

pip had a "home-grown" setup for vendoring dependencies. The invoke task grew in complexity to over 500 lines and, at some point, became extremely difficult to improve and maintain.

This tool is based off the overgrown invoke task, breaking it out into a dedicated codebase with the goal of making it more maintainable and reusable. This also enabled independent evolution of this codebase and better access to infrastructure (like dedicated CI) to ensure it keeps working properly.

Should I use it?

This tool has no stability promises -- it has only one intended user: pip. There may be unannounced changes to this codebase at any time, as long as the intended user (i.e. the pip project) is prepared for those changes.

As a general rule of thumb, if the project is going to be a PyPI package, it should not use this tool.

Many downstream redistributors have policies against this kind of bundling of dependencies, which means that they'll patch your software to debundle it. This can cause various kinds of issues, due to violations of assumptions being made about where the dependencies are available/which versions are being used. These issues result in difficult-to-debug errors, which are fairly difficult to communicate with end users.

pip is a very special case with a thorough rationale for vendoring/bundling dependencies with itself.

Contributing

Check the Contributing guide.