pipenv-to-requirements 0.1.8

Generate requirements[-dev].txt from Pipfile using pipenv

Generate requirements[-dev].txt from Pipfile (using pipenv)

• Free software: MIT

• Documentation: https://pipenv-to-requirements.readthedocs.org/en/latest/

• Source: https://github.com/Stibbons/pipenv-to-requirements

Rational

Pipfile and its sibling Pipfile.lock are clearly superior tools defining clear dependencies or a package. Pipfile is to be maintained by the package’s developer while Pipfile.lock represent a clear image of what is currently installed on the current system, guarantying full reproductibility of the setup. See more information about Pipfile format here. Most of the time, Pipfile.lock should be ignored (ie, not tracked in your git) for packages published on Pypi.

pipenv is a great tool to maintain Pipfile, but developers might be stuck with backward compatibility issues for tools and services that still use requirements.txt and does not know how to handle Pipfile or Pipfile.lock yet.

For examples:

• ReadTheDocs

• Pyup

• pip install (if you install a package with pip that does not have a requirements.txt, its dependencies won’t be installed, even if you use Pipfile)

Usage

Just before building source/binary/wheel package of your python module, execute:

To generate requirements files (ie, dependencies are described eventually by range):

pipenv run pipenv_to_requirements

To generate frozen requirements (ie, all dependencies have their version frozen):

pipenv run pipenv_to_requirements -f

It will generate requirements.txt and, if applicable, requirements-dev.txt, in the current directory.

Contributing

Create your development environment with

$ make dev

Execute unit tests:

$ make test

Build source, binary and wheels packages:

$ make dist

Code Style Checks:

$ make check

Code formatter:

$ make style

Create a release:

make requirements
git tag 1.2.3
make push

On successful Travis build on a Tag, your Pypi package will be updated automatically.