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.

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.

  • python will run the Python interpreter from the virtualenv, with any arguments forwarded.

  • where will give location information about the current project.

  • check asserts that PEP 508 requirements are being met by the current environment.

☤ Usage

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

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  check
  install
  lock
  python
  shell
  uninstall
  update
  where
$ pipenv where
Pipfile found at /Users/kennethreitz/repos/kr/pip2/test/Pipfile. Considering this to be the project home.
$ pipenv where --venv
Virtualenv location: /Users/kennethreitz/repos/kr/pip2/test/.venv
$ pipenv init
Pipfile found at /Users/kennethreitz/repos/kr/pip2/test/Pipfile. Considering this to be the project home.
Creating a virtualenv for this project...
...
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

☤ 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.6.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

pipenv-0.1.6-py2-none-any.whl (13.7 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for pipenv-0.1.6.tar.gz
Algorithm Hash digest
SHA256 b2627bcf83c208aac0375a85ff29c946c699002e1ed049ce92be45ef422fc606
MD5 97335934ec9fbf9675f908b1aba35267
BLAKE2b-256 65542b2e7cbc81dd13252c819b02cedadc85dc9ca8710e527914b8e1efd737c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pipenv-0.1.6-py2-none-any.whl
Algorithm Hash digest
SHA256 1794c68d70ad0e003fb94d2e9326d1aae31b371c1c24ce4f84f110be71e750c8
MD5 f5d3208b68764fc7338fffe0582dfa69
BLAKE2b-256 bb6197510b314d94dd1154d959cee7bbd4c52020de862bc7a7c65b10742f6183

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