skip to navigation
skip to content

pipenv 7.0.2

Sacred Marriage of Pipfile, Pip, & Virtualenv.

Latest Version: 8.0.1

Pipenv: Sacred Marriage of Pipfile, Pip, & Virtualenv

.. image::

.. image::

.. image::

.. image::

.. image::

.. image::

.. image::!-1EAEDB.svg


**Pipenv** — the officially recommended Python packaging tool from ` <https:"" new-tutorials="" installing-and-using-packages=""/>`_, free (as in freedom).

Pipenv harnesses `Pipfile <https:"" pypa="" pipfile="">`_, `Pip <https:"" pypa="" pip="">`_, and `Virtualenv <https:"" pypa="" virtualenv="">`_ together in unison to create a single, high-quality tool that is optimized for workflow efficiency and best practices. *Windows is a first–class citizen, in our world.*

Pipenv automatically creates and manages the virtualenvs of your projects, as well as adds/removes packages from your ``Pipfile`` as you install/uninstall packages. The ``lock`` command generates a lockfile (``Pipfile.lock``).

.. image::

The problems that Pipenv seeks to solve are multi-faceted:

- When using Pipenv, you no longer need to use ``pip`` and ``virtualenv`` separately. They work together.
- Managing a ``requirements.txt`` file `can be problematic <https:"" essays="" a-better-pip-workflow="">`_, so Pipenv uses the upcoming ``Pipfile`` and ``Pipfile.lock`` instead, which is superior for basic use cases.
- Hashes are used everywhere, always. Security.



$ pip install pipenv


☤ User Testimonials

**Jannis Leidel**, former pip maintainer—
*Pipenv is the porcelain I always wanted to build for pip. It fits my brain and mostly replaces virtualenvwrapper and manual pip calls for me. Use it.*

**Jhon Crypt**—
*Pipenv is the best thing since pip, thank you!*

**Isaac Sanders**—
*Pipenv is literally the best thing about my day today. Thanks, Kenneth!*

☤ Features

- Enables truly *deterministic builds*, while easily specifying *what you want*.
- Generates and checks file hashes for locked dependencies (via ``--hashes``).
- Automatically finds your project home, recursively, by looking for a ``Pipfile``.
- Automatically generates a ``Pipfile``, if one doesn't exist.
- Automatically generates a ``Pipfile.lock``, if one doesn't exist.
- Automatically creates a virtualenv in a standard location.
- Automatically adds packages to a Pipfile when they are installed.
- Automatically removes packages from a Pipfile when they are un-installed.
- Also automatically updates pip.

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

- ``shell`` will spawn a shell with the virtualenv activated.
- ``run`` will run a given command from the virtualenv, with any arguments forwarded (e.g. ``$ pipenv run python``).
- ``check`` asserts that PEP 508 requirements are being met by the current environment.
- ``graph`` will print a pretty graph of all your installed dependencies.

Shell Completion

Set ``_PIPENV_COMPLETE`` and then source the output of the program. For example, with fish, put this
in your ``~/.config/fish/completions/``::

eval (env _PIPENV_COMPLETE=source-fish pipenv)

Magic shell completions are now enabled! There is also a `fish plugin <https:"" fisherman="" pipenv="">`_, which will automatically activate your subshells for you!

Fish is the best shell. You should use it.

☤ Usage


$ pipenv
Usage: pipenv [OPTIONS] COMMAND [ARGS]...

--update Upate Pipenv & pip to latest.
--where Output project home information.
--venv Output virtualenv information.
--rm Remove the virtualenv.
--bare Minimal output.
--three / --two Use Python 3/2 when creating virtualenv.
--python TEXT Specify which version of Python virtualenv
should use.
-h, --help Show this message then exit.
-j, --jumbotron An easter egg, effectively.
--version Show the version and exit.

Usage Examples:
Create a new project using Python 3:
$ pipenv --three

Install all dependencies for a project (including dev):
$ pipenv install --dev

Create a lockfile:
$ pipenv lock

check Checks PEP 508 markers provided in Pipfile.
graph Displays currently–installed dependency graph...
install Installs provided packages and adds them to...
lock Generates Pipfile.lock.
run Spawns a command installed into the...
shell Spawns a shell within the virtualenv.
uninstall Un-installs a provided package and removes it...
update Updates Pipenv & pip to latest, uninstalls...

$ pipenv --where
Pipfile found at /Users/kennethreitz/repos/kr/pip2/test/Pipfile. Considering this to be the project home.


$ pipenv install
Creating a virtualenv for this project...
No package provided, installing all dependencies.
Virtualenv location: /Users/kennethreitz/.local/share/virtualenvs/test-EJkjoYts
Installing dependencies from Pipfile.lock...

To activate this project's virtualenv, run the following:
$ pipenv shell


$ pipenv install pytest --dev
Installing pytest...
Adding pytest to Pipfile's [dev-packages]...


$ pipenv graph
- certifi [required: >=2017.4.17, installed: 2017.7.27.1]
- chardet [required: >=3.0.2,<3.1.0, installed: 3.0.4]
- idna [required: >=2.5,<2.7, installed: 2.6]
- urllib3 [required: <1.23,>=1.21.1, installed: 1.22]


$ pipenv lock
Assuring all dependencies from Pipfile are installed...
Locking [dev-packages] dependencies...
Locking [packages] dependencies...
Note: your project now has only default [packages] installed.
To install [dev-packages], run: $ pipenv install --dev


$ pipenv install --dev
Pipfile found at /Users/kennethreitz/repos/kr/pip2/test/Pipfile. Considering this to be the project home.
Pipfile.lock out of date, updating...
Assuring all dependencies from Pipfile are installed...
Locking [dev-packages] dependencies...
Locking [packages] dependencies...


$ pipenv uninstall --all
No package provided, un-installing all dependencies.
Found 25 installed package(s), purging...
Environment now purged and fresh!


$ pipenv shell
Spawning virtualenv shell (/bin/zsh).

☤ Documentation

Documentation resides over at ` <http:""/>`_.
File Type Py Version Uploaded on Size
pipenv-7.0.2-py3-none-any.whl (md5) Python Wheel 3.6 2017-09-14 661KB
pipenv-7.0.2.tar.gz (md5) Source 2017-09-14 602KB