Documentation: `--ignore-pipfile` should be more clear; mention `pipenv sync`
See original GitHub issueThe --ignore-pipfile
flag reads:
Ignore Pipfile when installing, using the Pipfile.lock.
That would suggest it always installs dependencies as per the Pipfile.lock
file which doesn’t exactly seem to be the case.
pipenv sync
was added and only in the advanced documentation it mentions:
pipenv install --ignore-pipfile is nearly equivalent to pipenv sync, but pipenv sync will never attempt to re-lock your dependencies as it is considered an atomic operation. pipenv install by default does attempt to re-lock unless using the --deploy flag.
That distinction seems to be key and shouldn’t be hidden in the advanced section.
An intuitive command for installing dependencies is pipenv install
which was used before. It would make sense that if the documentation for pipenv install
would itself point to pipenv sync
as both are installing dependencies. And it’s not obvious one should maybe look for pipenv sync
.
Issue Analytics
- State:
- Created 5 years ago
- Reactions:15
- Comments:9
Top GitHub Comments
This is extremely confusing.
What I think it should be (and already is … for the most part):
install
should just install dependencies pinned on thepipfile.lock
. If nopipfile.lock
exists, install latest and create apipfile.lock
. In any other instance, do not touch thepipfile.lock
.lock
should be used when we are sure we want the versions currently installed. All other commands should warn us to run it, if we mess up, we have it versioned (in GIT) already anyway.sync
in its current state, makes no sense, in my mind its the same aslock
but currently thats not the case.install --ignore-pipfile
makes no sense.update
should get the latest version and warn us about updatingpipfile.lock
.update <specific>
should update get the latest of a single package and warn us about updatingpipfile.lock
.install --dev
(install bothdefault
anddevelop
) makes no sense, should be justinstall
.install --deploy
should be used instead if nodevelop
packages are wanted.Totally agree with @joaomcarlos , perhaps it deserves its own GH Issue?
Also, it seems that the behaviour of
pipenv install
changed recently. The--help
says that :which is not true anymore because: