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.9.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

pipenv-0.1.9-py2-none-any.whl (13.8 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for pipenv-0.1.9.tar.gz
Algorithm Hash digest
SHA256 141688cc3cdf29f1bbbd034ed4bda8b943aa65f83355a348ced3f67dc76f4713
MD5 5d0e14e60a126a531591a8cc5aeb73fd
BLAKE2b-256 a47c7dbfb8f2b0698b96a95a9c0778128c62f7aa5c944365ab62c7f178e15338

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pipenv-0.1.9-py2-none-any.whl
Algorithm Hash digest
SHA256 d280eba79d5ec17e45707874c7e4cff11e3f85d8cf534d81237831a2d0f94d77
MD5 98da584f9d0d77d5bd3f7a4d56001669
BLAKE2b-256 3db528bfa5ea21639d28d73675617fbdf62fd52222360508799c2aa9c25796c0

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