Pipenv: Python Dev Workflow for Humans

https://img.shields.io/pypi/v/pipenv.svg https://img.shields.io/pypi/l/pipenv.svg https://img.shields.io/pypi/pyversions/pipenv.svg https://img.shields.io/badge/Say%20Thanks!-🦉-1EAEDB.svg

Pipenv — the officially recommended Python packaging tool from Python.org, free (as in freedom).

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.

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, so Pipenv uses the upcoming Pipfile and Pipfile.lock instead, which is superior for basic use cases.
  • Hashes are used everywhere, always. Security. Automatically expose security vulnerabilities.
  • Give you insight into your dependency graph (e.g. $ pipenv graph).
  • Streamline development workflow by loading .env files.

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.
Justin Myles Holmes
Pipenv is finally an abstraction meant to engage the mind instead of merely the filesystem.
Isaac Sanders
Pipenv is literally the best thing about my day today. Thanks, Kenneth!

☤ 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.
  • run will run a given command from the virtualenv, with any arguments forwarded (e.g. $ pipenv run python).
  • check checks for security vulnerabilities and asserts that PEP 508 requirements are being met by the current environment.

☤ Pipenv Usage

pipenv

pipenv [OPTIONS] COMMAND [ARGS]...

Options

--update

Update Pipenv & pip to latest.

--where

Output project home information.

--venv

Output virtualenv information.

--py

Output Python interpreter information.

--envs

Output Environment Variable options.

--rm

Remove the virtualenv.

--bare

Minimal output.

--completion

Output completion (to be eval’d).

--man

Display manpage.

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--site-packages

Enable site-packages for the virtualenv.

--jumbotron

An easter egg, effectively.

--version

Show the version and exit.

check

Checks for security vulnerabilities and against PEP 508 markers provided in Pipfile.

pipenv check [OPTIONS] [ARGS]...

Options

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--unused <unused>

Given a code path, show potentially unused dependencies.

--style <style>

Given a code path, show Flake8 errors.

Arguments

ARGS

Optional argument(s)

graph

Displays currently–installed dependency graph information.

pipenv graph [OPTIONS]

Options

--bare

Minimal output.

--json

Output JSON.

--reverse

Reversed dependency graph.

install

Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages.

pipenv install [OPTIONS] [PACKAGE_NAME] [MORE_PACKAGES]...

Options

-d, --dev

Install package(s) in [dev-packages].

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--system

System pip management.

-r, --requirements <requirements>

Import a requirements.txt file.

-c, --code <code>

Import from codebase.

--verbose

Verbose mode.

--ignore-pipfile

Ignore Pipfile when installing, using the Pipfile.lock.

--sequential

Install dependencies one-at-a-time, instead of concurrently.

--skip-lock

Ignore locking mechanisms when installing—use the Pipfile, instead.

--deploy

Abort if the Pipfile.lock is out–of–date, or Python version is wrong.

--pre

Allow pre–releases.

Arguments

PACKAGE_NAME

Optional argument

MORE_PACKAGES

Optional argument(s)

lock

Generates Pipfile.lock.

pipenv lock [OPTIONS]

Options

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--verbose

Verbose mode.

-r, --requirements

Generate output compatible with requirements.txt.

--clear

Clear the dependency cache.

--pre

Allow pre–releases.

open

View a given module in your editor.

pipenv open [OPTIONS] MODULE

Options

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

Arguments

MODULE

Required argument

run

Spawns a command installed into the virtualenv.

pipenv run [OPTIONS] COMMAND [ARGS]...

Options

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

Arguments

COMMAND

Required argument

ARGS

Optional argument(s)

shell

Spawns a shell within the virtualenv.

pipenv shell [OPTIONS] [SHELL_ARGS]...

Options

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--fancy

Run in shell in fancy mode (for elegantly configured shells).

--anyway

Always spawn a subshell, even if one is already spawned.

Arguments

SHELL_ARGS

Optional argument(s)

uninstall

Un-installs a provided package and removes it from Pipfile.

pipenv uninstall [OPTIONS] [PACKAGE_NAME] [MORE_PACKAGES]...

Options

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--system

System pip management.

--verbose

Verbose mode.

--lock

Lock afterwards.

-d, --dev

Un-install all package from [dev-packages].

--all

Purge all package(s) from virtualenv. Does not edit Pipfile.

Arguments

PACKAGE_NAME

Optional argument

MORE_PACKAGES

Optional argument(s)

update

Uninstalls all packages, and re-installs package(s) in [packages] to latest compatible versions.

pipenv update [OPTIONS] [PACKAGE_NAME]

Options

-v, --verbose

Verbose mode.

-d, --dev

Additionally install package(s) in [dev-packages].

--three, --two

Use Python 3/2 when creating virtualenv.

--python <python>

Specify which version of Python virtualenv should use.

--dry-run

Just output outdated packages.

--bare

Minimal output.

--clear

Clear the dependency cache.

--sequential

Install dependencies one-at-a-time, instead of concurrently.

Arguments

PACKAGE_NAME

Optional argument

Indices and tables