Files
pipenv/docs/workflows.md
Matt Davis 09799120a0 pipenv 3000 install (behavioral refactor) (#6098)
* 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.
2024-06-02 23:16:48 -04:00

1.3 KiB

Pipenv Workflows

Clone / create project repository:

$ cd myproject

Install from Pipfile.lock, if there is one:

$ pipenv install

Add a package to your project, recalibrating subset of lock file using the Pipfile specifiers:

$ pipenv install <package>
  • Note: This will create a Pipfile if one doesn't exist. If one does exist, it will automatically be edited with the new package you provided, the lock file updated and the new dependencies installed.
  • pipenv install is fully compatible with pip install package specifiers.
  • Additional arguments may be supplied to pip by supplying pipenv with --extra-pip-args.

Update everything (equivalent to pipenv lock && pipenv sync):

$ pipenv update

Update and install just the relevant package and its sub-dependencies:

$ pipenv update <package>

Update in the Pipfile/lockfile just the relevant package and its sub-dependencies:

$ pipenv upgrade <package>

Find out what's changed upstream:

$ pipenv update --outdated

Determine the virtualenv PATH:

$ pipenv --venv

Activate the Pipenv shell:

$ pipenv shell
  • Note: This will spawn a new shell subprocess, which can be deactivated by using exit.