Skip to main content

reqwire: wire up Python requirements with pip-tools.

Project description

Codacy Badge https://img.shields.io/pypi/v/reqwire.svg https://img.shields.io/pypi/pyversions/reqwire.svg https://travis-ci.org/darvid/reqwire.svg?branch=master https://img.shields.io/coveralls/darvid/reqwire.svg Join the chat at https://gitter.im/python-reqwire/Lobby

reqwire wires up your pip requirements with pip-tools.

https://asciinema.org/a/97035.png

Install

>From PyPI:

$ pip install -U reqwire

>From source:

$ pip install -e git+https://github.com/darvid/reqwire.git#egg=reqwire

Features

  • Manage multiple requirement source files, or tags

  • Add requirements from the command line (à la npm --save)

  • Compile tagged source files with pip-compile (from pip-tools)

Rationale

Until PEP 518 and Pipfile become reality, maintaining one or more requirements.txt files for Python projects will continue to be subject to personal preference and differing opinions on best practices [1]. Typical workflows involve maintaining multiple requirements.txt files, and many projects have some form of tooling, be it Makefile targets or external tools, such as Vincent Driessen’s excellent pip-tools.

reqwire is a glorified wrapper around pip-tools, and imposes a slightly opinionated workflow:

  • Python requirements are split into source files and built files, with the built files being the output from pip-compile, containing pinned versions of the entire dependency graph. (Use reqwire init to quickly scaffold the necessary directory structure.)

  • Source files (with the .in extension) represent a project’s immediate dependencies, and are always pinned to specific versions or version ranges.

  • Source filenames are synonymous with tags, which can be passed to reqwire add and reqwire build to maintain requirements for entirely separate environments.

Disclaimer

reqwire makes no claims about being designed specifically for humans, bonobos, cats, or any other land mammal. This project is not farm raised, free range, organic, low sugar, MSG free, gluten free, halal, kosher, vegan, or particularly of any nutritional value whatsoever. It just wraps pip-tools and helps you manage your freakin Python requirements. ☮ 🌈

Roadmap

  • Unit tests

  • Provide a command to update requirements (user-specified version)

  • Provide a command to freshen requirements

  • Provide a command to combine tags to a single output file (easily possible with pip-compile)

  • Provide a utility for generating setup and runtime requirements in setup.py scripts using setuptools.

  • Abandon in favor of Pipfile 👌

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

reqwire-0.2.1-py2.py3-none-any.whl (20.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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