Generate requirements[-dev].txt from Pipfile using pipenv
Project description
Generate requirements[-dev].txt from Pipfile (using pipenv).
Free software: MIT
Documentation: https://pipenv-to-requirements.readthedocs.org/en/latest/
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:
Any library that uses PBR (*)
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)
(*): for the moment, I recommend to use generate at least requirements.txt (without version freeze) for the libraries using PBR that you publish on Pypi. This allows automatic installation of the very dependencies of your package. Without this file, your package will be installed by pip without its dependencies. Support in PBR may be added in the future (see this this patch ).
Usage
Just before building source/binary/wheel package of your python module, only of the following commands:
To generate requirements files (ie, dependencies are described eventually by range):
pipenv run pipenv_to_requirementsTo 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.
ReadTheDocs
Simply commit these files in your tree so that readthedocs, and ensure they are synchronized each time you change your Pipfile. Do not forget to ask ReadTheDocs to use requirements-dev.txt when building the documentation.
Contributing
Create your development environment with
$ make devExecute unit tests:
$ make testCode formatter:
$ make styleCode Style Checks:
$ make checkRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pipenv-to-requirements-0.3.1.tar.gz.
File metadata
- Download URL: pipenv-to-requirements-0.3.1.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0bb9493296128ce67b747313305a8616bb986b4ca1f55488d5ae9f34b16da3be |
|
| MD5 | e92ed9d7596222fecd67bb3695857538 |
|
| BLAKE2b-256 | 33f4a21cfa509cdc4da421b5192f7254e9584b4d52d8d6d58723bf0a978c9b95 |
File details
Details for the file pipenv_to_requirements-0.3.1-py2.py3-none-any.whl.
File metadata
- Download URL: pipenv_to_requirements-0.3.1-py2.py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 55e904c6ef16261ce99b6551620a731dae5f74109d2a111139b995ac234ed54a |
|
| MD5 | 3acaf568262e4b233c4c1249bc21e7ab |
|
| BLAKE2b-256 | ccb0af6cb15468e2c53c30fdff9fbc8a3980ca191efcce576e9106c21e8f4b5b |
