Skip to main content

Sacred Marriage of Pipfile, Pip, & Virtualenv.

Project description

Pipenv is an experimental project that aims to bring the best of all packaging worlds to the Python world. It harnesses Pipfile, pip, and virtualenv into one single toolchain. It features very pretty terminal colors.

http://media.kennethreitz.com.s3.amazonaws.com/s8.gif

It automatically creates and manages a virtualenv for your projects, as well as adds/removes packages from your Pipfile as you install/uninstall packages. The lock command generates a lockfile (Pipfile.lock).

☤ Features

  • 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 (project/.venv).

  • 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.

Basic Concepts

  • A virtualenv will automatically be created, when one doesn’t exist.

  • When no parameters are passed to install, all packages specified will be installed.

  • When no parameters are passed to uninstall, all packages will be uninstalled.

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.

☤ Usage

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

Options:
  --where    Output project home information.
  --bare     Minimal output.
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  check      Checks PEP 508 markers provided in Pipfile.
  install    Installs a provided package and adds it to...
  lock       Generates Pipfile.lock.
  run        Spans a command installed into the...
  shell      Spans a shell within the virtualenv.
  uninstall  Un-installs a provided package and removes it...
  update     Updates pip to latest version, uninstalls all...
$ 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/repos/kr/pip2/test/.venv
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 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 init --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...
Note: your project now has only default [packages] installed.
To install [dev-packages], run: $ pipenv install --dev
Installing dependencies from Pipfile.lock...
...
$ pipenv uninstall
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).
(test)$

☤ Installation

$ pip install pipenv

✨🍰✨

Project details


Release 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

pipenv-0.1.14.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

pipenv-0.1.14-py2-none-any.whl (14.6 kB view details)

Uploaded Python 2

File details

Details for the file pipenv-0.1.14.tar.gz.

File metadata

  • Download URL: pipenv-0.1.14.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pipenv-0.1.14.tar.gz
Algorithm Hash digest
SHA256 a6a28b71a530ca454a927ebf3d0c135e9e7806a8983a3462eec35e2aa6234831
MD5 39acc1b4e78dfe725d39d37b63c84473
BLAKE2b-256 8d894c1d7d9d0500d024ca9edc394c0f10c2df59f608cf37f33775f8005e6a8b

See more details on using hashes here.

File details

Details for the file pipenv-0.1.14-py2-none-any.whl.

File metadata

File hashes

Hashes for pipenv-0.1.14-py2-none-any.whl
Algorithm Hash digest
SHA256 0cbba94884fbdef4ce6a2b0997171b9ee29d704439129b95d3423ec1fe9f9c2c
MD5 6648ef8c30bbea68421450989616bf5b
BLAKE2b-256 7c795116ada7e292037c646f909ed86aa00a4af6766ca0e4eb70cd56eb1d44e8

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