Files
pipenv/docs/workflows.md
T
Matt Davis 761a03d088 Doc revisions1 (#5621)
* Begin reviewing the basics docs.

* Check in delta

* More doc revisions.

* Split apart basics docs.

* Refactor based on building docs

* add the files back as markdown.

* more conversions to markdown.

* more conversions to markdown.

* fix markdown formatting.

* convert index to markdown.

* More docs review

* More markdown and doc revisions.

* Fix docs.

* Update doc build requirements.

* fix lint

* Fix build with update/upgrade command.

* remove useless quickstart and update the commands section.

* Fix lint

* change ordering of table of contents.

* fix changelog duplicate headings.

* Start splitting advanced topics.

* minor nits

* Move some sections from advanced to shell.

* remove this section as its stale and kind of off topic.

* move scripts out into its own section.

* Wrap up revisions1

* fix lint

* address PR feedback and other nits.

* fix lint

* Try improving ordering of table of contents, fix issue with indexes.md file location.

* fix lint

* PR feedback.
2023-03-18 08:44:58 +01:00

1.3 KiB

Pipenv Workflows

Clone / create project repository::

$ cd myproject

Install from Pipfile.lock, if there is one::

$ pipenv sync

Add a package to your project, recalibrating entire 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, for which the full documentation can be found here <https://pip.pypa.io/en/stable/user_guide/#installing-packages>__.
  • 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.