From 62c2bd78ca58934d29702c54d18ad6f7e4d7b7e0 Mon Sep 17 00:00:00 2001 From: Gabi Nagy Date: Tue, 11 Sep 2018 16:25:57 +0300 Subject: [PATCH 1/5] Clarify `pipenv install` documentation `if no packages are given` sounds a bit better than `if none is given` when referring to `provided packages`. Also mention that `pipenv install` with no provided packages installs all packages from Pipfile. It is not obvious for people new to pipenv whether pipenv is using Pipfile or Pipfile.lock by default. --- README.md | 4 ++-- pipenv/cli/command.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e23f148..f6af5917 100644 --- a/README.md +++ b/README.md @@ -181,8 +181,8 @@ Fish is the best shell. You should use it. provided in Pipfile. clean Uninstalls all packages not specified in Pipfile.lock. graph Displays currently–installed dependency graph information. - install Installs provided packages and adds them to Pipfile, or (if none - is given), installs all packages. + install Installs provided packages and adds them to Pipfile, or (if no + packages are given), installs all packages from Pipfile. lock Generates Pipfile.lock. open View a given module in your editor. run Spawns a command installed into the virtualenv. diff --git a/pipenv/cli/command.py b/pipenv/cli/command.py index f6c0d133..b552778f 100644 --- a/pipenv/cli/command.py +++ b/pipenv/cli/command.py @@ -209,7 +209,7 @@ def cli( @cli.command( - short_help="Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages.", + short_help="Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile.", context_settings=dict(ignore_unknown_options=True, allow_extra_args=True), ) @system_option @@ -224,7 +224,7 @@ def install( state, **kwargs ): - """Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages.""" + """Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile.""" from ..core import do_install retcode = do_install( From 408ed9be46938d8ddcda26ab68d4a82eae614abe Mon Sep 17 00:00:00 2001 From: Gabi Nagy Date: Tue, 11 Sep 2018 17:05:17 +0300 Subject: [PATCH 2/5] Add fragment to the news directory --- news/2844.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 news/2844.doc diff --git a/news/2844.doc b/news/2844.doc new file mode 100644 index 00000000..28f26514 --- /dev/null +++ b/news/2844.doc @@ -0,0 +1 @@ +Clarify `pipenv install` documentation From 51c3c8b6004b65256e06e7cfecf524db6efa15b0 Mon Sep 17 00:00:00 2001 From: Gabi Nagy Date: Thu, 13 Sep 2018 17:02:56 +0300 Subject: [PATCH 3/5] Fix `pipenv install --dev` description By default, `pipenv install` will install packages based on the list in `Pipfile`, not `Pipfile.lock`. `pipenv install --dev` is no exception. I've tested this using pipenv 2018.7.1 with different package versions in `Pipfile` and `Pipfile.lock`. After `pipenv install`, the versions in `Pipfile` were the ones actually installed. --- docs/basics.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/basics.rst b/docs/basics.rst index 559f7570..5d41249f 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -287,7 +287,7 @@ The user can provide these additional parameters: folder is encoded into a "slug value" and appended to ensure the virtualenv name is unique. - - ``--dev`` — Install both ``develop`` and ``default`` packages from ``Pipfile.lock``. + - ``--dev`` — Install both ``develop`` and ``default`` packages from ``Pipfile``. - ``--system`` — Use the system ``pip`` command rather than the one from your virtualenv. - ``--ignore-pipfile`` — Ignore the ``Pipfile`` and install from the ``Pipfile.lock``. - ``--skip-lock`` — Ignore the ``Pipfile.lock`` and install from the ``Pipfile``. In addition, do not write out a ``Pipfile.lock`` reflecting changes to the ``Pipfile``. From 9105ac415b989118af0df52f717840624b411850 Mon Sep 17 00:00:00 2001 From: Gabi Nagy Date: Thu, 13 Sep 2018 17:35:59 +0300 Subject: [PATCH 4/5] Fix `pipenv install --dev` help text The previous help text made it seem that `pipenv install --dev` would install ONLY dev-packages, which is not the case. The current description is identical to the one used in the documentation, which is a lot clearer. --- pipenv/cli/options.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipenv/cli/options.py b/pipenv/cli/options.py index cf9daa19..99fc5344 100644 --- a/pipenv/cli/options.py +++ b/pipenv/cli/options.py @@ -166,7 +166,7 @@ def dev_option(f): state.installstate.dev = value return value return option("--dev", "-d", is_flag=True, default=False, type=click_booltype, - help="Install package(s) in [dev-packages].", callback=callback, + help="Install both develop and default packages.", callback=callback, expose_value=False)(f) From 4851fe513cb943e340a1ac306a2ade0309354c61 Mon Sep 17 00:00:00 2001 From: Jon Dufresne Date: Sun, 16 Sep 2018 11:35:28 -0700 Subject: [PATCH 5/5] Correct capitalization of PyPI As spelled on https://pypi.org/. --- HISTORY.txt | 2 +- setup.py | 2 +- tests/pytest-pypi/setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/HISTORY.txt b/HISTORY.txt index 74c251e6..04717e2a 100644 --- a/HISTORY.txt +++ b/HISTORY.txt @@ -737,7 +737,7 @@ 6.0.0: - New locking functionality — support for multiple hashes per release! - Hashes are now default, everywhere, once again! We figured it out :) - - Pipenv talks to the PyPi (Warehouse) API now for grabbing hashes. + - Pipenv talks to the PyPI (Warehouse) API now for grabbing hashes. - --hashes flag removed. - Upgraded to Pipfile spec 2. - New --legacy mode for lock. diff --git a/setup.py b/setup.py index ea5af031..4a6b9389 100644 --- a/setup.py +++ b/setup.py @@ -92,7 +92,7 @@ class UploadCommand(Command): pass self.status("Building Source distribution…") os.system("{0} setup.py sdist bdist_wheel".format(sys.executable)) - self.status("Uploading the package to PyPi via Twine…") + self.status("Uploading the package to PyPI via Twine…") os.system("twine upload dist/*") self.status("Pushing git tags…") os.system("git tag v{0}".format(about["__version__"])) diff --git a/tests/pytest-pypi/setup.py b/tests/pytest-pypi/setup.py index 3341b098..87f6b752 100644 --- a/tests/pytest-pypi/setup.py +++ b/tests/pytest-pypi/setup.py @@ -42,7 +42,7 @@ class UploadCommand(Command): self.status('Building Source and Wheel (universal) distribution…') os.system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable)) - self.status('Uploading the package to PyPi via Twine…') + self.status('Uploading the package to PyPI via Twine…') os.system('twine upload dist/*') self.status('Pushing git tags…')