Matt Davis
09799120a0
* Pipenv 3000 install refactor * add news fragment. * Factor out do_install_dependencies from do_init as it made no sense; reduce down unused arguments; no longer perform full lock resolution during install commands. * Fix other issues affecting the CI * Factor out validations to eliminate ruff branching factor error. * provide documentation updates for this important pipenv 3000 behavioral change. * PR Feedback. * Further refinements to the docs.
2.1 KiB
Pipenv CLI Reference
pipenv
pipenv [OPTIONS] COMMAND [ARGS]...
check
Checks for PyUp Safety security vulnerabilities and against PEP 508 markers provided in Pipfile.
pipenv check [OPTIONS]
clean
Uninstalls all packages not specified in Pipfile.lock.
pipenv clean [OPTIONS]
graph
Displays currently–installed dependency graph information.
pipenv graph [OPTIONS]
install
Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile.lock
pipenv install [OPTIONS] [PACKAGES]...
Environment Variables
PIP_INDEX_URL
Provide a default for -i
lock
Generates Pipfile.lock.
pipenv lock [OPTIONS]
open
View a given module in your editor.
This uses the EDITOR environment variable. You can temporarily override it, for example:
EDITOR=atom pipenv open requests
pipenv open [OPTIONS] MODULE
requirements
Generate a requirements.txt from Pipfile.lock.
pipenv requirements [OPTIONS]
run
Spawns a command installed into the virtualenv.
pipenv run [OPTIONS] COMMAND [ARGS]...
scripts
Lists scripts in current environment config.
pipenv scripts [OPTIONS]
shell
Spawns a shell within the virtualenv.
pipenv shell [OPTIONS] [SHELL_ARGS]...
sync
Installs all packages specified in Pipfile.lock.
pipenv sync [OPTIONS]
uninstall
Un-installs a provided package and removes it from Pipfile.
pipenv uninstall [OPTIONS] [PACKAGES]...
update
Runs lock when no packages are specified, or upgrade, and then sync.
pipenv update [OPTIONS] [PACKAGES]...
Environment Variables
PIP_INDEX_URL
Provide a default for -i
upgrade
Resolves provided packages and adds them to Pipfile, or (if no packages are given), merges results to Pipfile.lock
pipenv upgrade [OPTIONS] [PACKAGES]...
Environment Variables
PIP_INDEX_URL
Provide a default for -i
verify
Verify the hash in Pipfile.lock is up-to-date.
pipenv verify [OPTIONS]