Skip to main content

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

Project description

https://travis-ci.org/Stibbons/pipenv-to-requirements.svg?branch=master Pypi package MIT licensed

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

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 generated frozen dependencies:

pipenv run pipenv_to_requirements -f

For not frozen dependencies:

pipenv run pipenv_to_requirements

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.

Project details


Download files

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

Source Distribution

pipenv-to-requirements-0.1.2.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

pipenv_to_requirements-0.1.2-py2.py3-none-any.whl (10.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pipenv-to-requirements-0.1.2.tar.gz.

File metadata

File hashes

Hashes for pipenv-to-requirements-0.1.2.tar.gz
Algorithm Hash digest
SHA256 44583554441b30985cc3190e2ab56d5d415860db98dec1cd03e8323fd45d419d
MD5 73cac5b7146e6f1fbf0576d50e8fa160
BLAKE2b-256 0215313edf698642976155d0bbafddb4725ed930e690608b879035c45cde9d9e

See more details on using hashes here.

File details

Details for the file pipenv_to_requirements-0.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pipenv_to_requirements-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bec665b9daf56a4086c3890d5220b57574e2ebb326fc13e5a73f858a1a025ff1
MD5 b1d5b0181055411e7390caee973b4cea
BLAKE2b-256 6eb0cca9a911d946c3bfb4b60cd846704b3233c0f60db90ab5905758fe9febc0

See more details on using hashes here.

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