mirror of
https://github.com/kennethreitz/pipenv.git
synced 2026-06-05 22:50:18 +00:00
Sumana Harihareswara
603a20bf45
The canonical Pipenv documentation is now at pipenv.pypa.io. Also, the canonical GitHub repositories for Pipenv and Requests have changed, and some other communications links (Twitter, mailing list, "thank you") were no longer operational. This commit updates those and clarifies that Pipenv is a project maintained by the PyPA. Fixes #4137. Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
138 lines
5.5 KiB
ReStructuredText
138 lines
5.5 KiB
ReStructuredText
.. pipenv documentation master file, created by
|
|
sphinx-quickstart on Mon Jan 30 13:28:36 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Pipenv: Python Dev Workflow for Humans
|
|
======================================
|
|
|
|
.. image:: https://img.shields.io/pypi/v/pipenv.svg
|
|
:target: https://pypi.python.org/pypi/pipenv
|
|
|
|
.. image:: https://img.shields.io/pypi/l/pipenv.svg
|
|
:target: https://pypi.python.org/pypi/pipenv
|
|
|
|
.. image:: https://img.shields.io/pypi/pyversions/pipenv.svg
|
|
:target: https://pypi.python.org/pypi/pipenv
|
|
|
|
---------------
|
|
|
|
**Pipenv** is a tool that aims to bring the best of all packaging worlds (bundler, composer, npm, cargo, yarn, etc.) to the Python world. *Windows is a first-class citizen, in our world.*
|
|
|
|
It automatically creates and manages a virtualenv for your projects, as well as adds/removes packages from your ``Pipfile`` as you install/uninstall packages. It also generates the ever-important ``Pipfile.lock``, which is used to produce deterministic builds.
|
|
|
|
Pipenv is primarily meant to provide users and developers of applications with an easy method to setup a working environment. For the distinction between libraries and applications and the usage of ``setup.py`` vs ``Pipfile`` to define dependencies, see :ref:`pipfile-vs-setuppy`.
|
|
|
|
.. image:: https://gist.githubusercontent.com/jlusk/855d611bbcfa2b159839db73d07f6ce9/raw/7f5743401809f7e630ee8ff458faa980e19924a0/pipenv.gif
|
|
:height: 341px
|
|
:width: 654px
|
|
:scale: 100 %
|
|
:alt: a short animation of pipenv at work
|
|
|
|
The problems that Pipenv seeks to solve are multi-faceted:
|
|
|
|
- You no longer need to use ``pip`` and ``virtualenv`` separately. They work together.
|
|
- Managing a ``requirements.txt`` file `can be problematic <https://www.kennethreitz.org/essays/a-better-pip-workflow>`_, so Pipenv uses ``Pipfile`` and ``Pipfile.lock`` to separate abstract dependency declarations from the last tested combination.
|
|
- Hashes are used everywhere, always. Security. Automatically expose security vulnerabilities.
|
|
- Strongly encourage the use of the latest versions of dependencies to minimize security risks `arising from outdated components <https://www.owasp.org/index.php/Top_10-2017_A9-Using_Components_with_Known_Vulnerabilities>`_.
|
|
- Give you insight into your dependency graph (e.g. ``$ pipenv graph``).
|
|
- Streamline development workflow by loading ``.env`` files.
|
|
|
|
You can quickly play with Pipenv right in your browser:
|
|
|
|
.. image:: https://cdn.rawgit.com/rootnroll/library/assets/try.svg
|
|
:target: https://rootnroll.com/d/pipenv/
|
|
:alt: Try in browser
|
|
|
|
|
|
Install Pipenv Today!
|
|
---------------------
|
|
|
|
If you're on MacOS, you can install Pipenv easily with Homebrew. You can also use Linuxbrew on Linux using the same command::
|
|
|
|
$ brew install pipenv
|
|
|
|
Or, if you're using Fedora 28::
|
|
|
|
$ sudo dnf install pipenv
|
|
|
|
Otherwise, refer to the :ref:`installing-pipenv` chapter for instructions.
|
|
|
|
✨🍰✨
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
install
|
|
changelog
|
|
|
|
User Testimonials
|
|
-----------------
|
|
|
|
**David Gang**—
|
|
*This package manager is really awesome. For the first time I know exactly what my dependencies are which I installed and what the transitive dependencies are. Combined with the fact that installs are deterministic, makes this package manager first class, like cargo*.
|
|
|
|
**Justin Myles Holmes**—
|
|
*Pipenv is finally an abstraction meant to engage the mind instead of merely the filesystem.*
|
|
|
|
☤ Pipenv Features
|
|
-----------------
|
|
|
|
- Enables truly *deterministic builds*, while easily specifying *only what you want*.
|
|
- Generates and checks file hashes for locked dependencies.
|
|
- Automatically install required Pythons, if ``pyenv`` is available.
|
|
- Automatically finds your project home, recursively, by looking for a ``Pipfile``.
|
|
- Automatically generates a ``Pipfile``, if one doesn't exist.
|
|
- Automatically creates a virtualenv in a standard location.
|
|
- Automatically adds/removes packages to a ``Pipfile`` when they are un/installed.
|
|
- Automatically loads ``.env`` files, if they exist.
|
|
|
|
The main commands are ``install``, ``uninstall``, and ``lock``, which generates a ``Pipfile.lock``. These are intended to replace ``$ pip install`` usage, as well as manual virtualenv management (to activate a virtualenv, run ``$ pipenv shell``).
|
|
|
|
Basic Concepts
|
|
//////////////
|
|
|
|
- A virtualenv will automatically be created, when one doesn't exist.
|
|
- When no parameters are passed to ``install``, all packages ``[packages]`` specified will be installed.
|
|
- To initialize a Python 3 virtual environment, run ``$ pipenv --three``.
|
|
- To initialize a Python 2 virtual environment, run ``$ pipenv --two``.
|
|
- Otherwise, whatever virtualenv defaults to will be the default.
|
|
|
|
|
|
|
|
Other Commands
|
|
//////////////
|
|
|
|
- ``graph`` will show you a dependency graph of your installed dependencies.
|
|
- ``shell`` will spawn a shell with the virtualenv activated. This shell can be deactivated by using ``exit``.
|
|
- ``run`` will run a given command from the virtualenv, with any arguments forwarded (e.g. ``$ pipenv run python`` or ``$ pipenv run pip freeze``).
|
|
- ``check`` checks for security vulnerabilities and asserts that PEP 508 requirements are being met by the current environment.
|
|
|
|
|
|
Further Documentation Guides
|
|
----------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
basics
|
|
advanced
|
|
cli
|
|
diagnose
|
|
|
|
Contribution Guides
|
|
-------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
dev/philosophy
|
|
dev/contributing
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|