Sacred Marriage of Pipfile, Pip, & Virtualenv.
Project description
Pipenv: Sacred Marriage of Pipfile, Pip, & Virtualenv
=====================================================
Pipenv is an experimental project that aims to bring the best of all packaging worlds to the Python world. It harnesses `Pipfile <https://github.com/pypa/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:
--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.
python Spans a Python interpreter within the...
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!
☤ Installation
--------------
::
$ pip install pipenv
✨🍰✨
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.11.tar.gz
(9.2 kB
view details)
Built Distribution
pipenv-0.1.11-py2-none-any.whl
(14.4 kB
view details)
File details
Details for the file pipenv-0.1.11.tar.gz.
File metadata
- Download URL: pipenv-0.1.11.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 763294381ccd9929e8b9a2d44b2e26c7072304e8f066370f0e19bad645b0eecf |
|
| MD5 | 93bfa8eea3cd02dae2aeb79c9f379fa4 |
|
| BLAKE2b-256 | 661726d7e05ac111356661f405eed0ece7592aa9dbe0cab3d66df676201221e2 |
File details
Details for the file pipenv-0.1.11-py2-none-any.whl.
File metadata
- Download URL: pipenv-0.1.11-py2-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2097733b72d23fc0f15d9b89b66540a2ce953e0b601639b46ca5d191bd045c34 |
|
| MD5 | af15ef514b42cf51097a3bd6b21a5720 |
|
| BLAKE2b-256 | 72e8434fccddce370e6880d76dd84cf04c281ac9074ecc0ab2c0d6b6700ac0a9 |
