From cdda776a8e8c2f4f86f9448b495978c3f7d7a52b Mon Sep 17 00:00:00 2001 From: Mavaddat Javid Date: Sun, 24 May 2020 18:17:35 -0700 Subject: [PATCH 1/4] Remove April caveat, add pre-release notice The pipenv team hit their April and May release targets, so the caveat about the seeming impasse of pipenv development no longer applies. However, it may benefit the user to know that the early access version of the package is available as pre-release in `pip`. --- source/tutorials/managing-dependencies.rst | 31 +++++----------------- 1 file changed, 6 insertions(+), 25 deletions(-) diff --git a/source/tutorials/managing-dependencies.rst b/source/tutorials/managing-dependencies.rst index 3a512568b..855e453f4 100644 --- a/source/tutorials/managing-dependencies.rst +++ b/source/tutorials/managing-dependencies.rst @@ -26,31 +26,6 @@ as Python libraries, should also consider the `poetry `_ project as an alternative dependency management solution. - -Recommendation caveats (as of April 2020) ------------------------------------------ - -While this tutorial covers the ``pipenv`` project as a tool that focuses -primarily on the needs of Python application development rather than Python -library development, the project itself is currently working through several -`process and maintenance issues `_ -that are preventing bug fixes and new features from being published (with the -entirety of 2019 passing without a new release). - -This means that in the near term, ``pipenv`` still suffers from several quirks -and performance problems without a clear timeline for resolution of those isses. - -While this remains the case, project maintainers are likely to want to -investigate :ref:`other-dependency-management-tools` for use instead of, or -together with, ``pipenv``. - -Assuming the April 2020 ``pipenv`` release goes ahead as planned, and the -release after that also remains on track, then this caveat on the tutorial will -be removed. If those releases *don't* remain on track, then the tutorial itself -will be removed, and replaced with a discussion page on the available dependency -management options. - - Installing Pipenv ----------------- @@ -66,6 +41,12 @@ Use ``pip`` to install Pipenv: pip install --user pipenv +At present, the `latest Pipenv `_ is in pre-release stage after a long hiatus. If you run into a bug that `appears to be addressed `_ by the latest preview version, you may want to try installing the pre-release by specifying the version in `pip` as follows: + +.. code-block:: python + + pip install pipenv==2020.4.1b2 + .. _pipenv-user-base: .. Note:: This does a `user installation`_ to prevent breaking any system-wide From 4ab024419887a835fc72e39661979634c5ab5671 Mon Sep 17 00:00:00 2001 From: Mavaddat Javid Date: Wed, 27 May 2020 21:21:18 -0700 Subject: [PATCH 2/4] restored caveat with some wording changes I re-ordered the phrasing to give the reader a sense of the big picture first. Also, I attempted to clarify the language about library vs application development. However, I am not sure if I captured the spirit of what was intended by those words by the previous author. --- source/tutorials/managing-dependencies.rst | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/source/tutorials/managing-dependencies.rst b/source/tutorials/managing-dependencies.rst index 855e453f4..ebed05baa 100644 --- a/source/tutorials/managing-dependencies.rst +++ b/source/tutorials/managing-dependencies.rst @@ -26,6 +26,22 @@ as Python libraries, should also consider the `poetry `_ project as an alternative dependency management solution. +Recommendation caveats (circa June 2020) +----------------------------------------- + +At present, the ``pipenv`` project team is `staging multiple bug fixes and features `_, so the tool continues to suffer from several quirks and performance problems. The latest updates are in pre-release stage after long hiatus in its project activity. + +Because of these issues, you may find you need to troubleshoot the tool itself. While this tutorial covers ``pipenv`` project as a tool for Python *application* development, the abovementioned troubleshooting may necessitate thinking of ``pipenv`` itself as a *library* in development. If you run into a bug that `appears to be addressed `_ by the latest preview version, you may want to try the `latest Pipenv `_. In such a case, you may want to install the pre-release by specifying the version string in `pip` as follows: + +.. code-block:: python + + pip install pipenv==2020.4.1b2 + +Alternatively, project maintainers may want to investigate :ref:`other-dependency-management-tools` for use instead or +alongside ``pipenv``. + +The above caveat on the tutorial will remain until the most recent ``pipenv`` is a stable release. + Installing Pipenv ----------------- @@ -41,12 +57,6 @@ Use ``pip`` to install Pipenv: pip install --user pipenv -At present, the `latest Pipenv `_ is in pre-release stage after a long hiatus. If you run into a bug that `appears to be addressed `_ by the latest preview version, you may want to try installing the pre-release by specifying the version in `pip` as follows: - -.. code-block:: python - - pip install pipenv==2020.4.1b2 - .. _pipenv-user-base: .. Note:: This does a `user installation`_ to prevent breaking any system-wide From 9730a98c3c1fe594d6635d8d6a330e8886db15c8 Mon Sep 17 00:00:00 2001 From: Mavaddat Javid Date: Thu, 28 May 2020 14:47:33 -0700 Subject: [PATCH 3/4] tidied up the language I removed some redundant language. --- source/tutorials/managing-dependencies.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/tutorials/managing-dependencies.rst b/source/tutorials/managing-dependencies.rst index ebed05baa..6602b7a0c 100644 --- a/source/tutorials/managing-dependencies.rst +++ b/source/tutorials/managing-dependencies.rst @@ -29,9 +29,9 @@ management solution. Recommendation caveats (circa June 2020) ----------------------------------------- -At present, the ``pipenv`` project team is `staging multiple bug fixes and features `_, so the tool continues to suffer from several quirks and performance problems. The latest updates are in pre-release stage after long hiatus in its project activity. +At present, the ``pipenv`` project team is `staging multiple bug fixes and features `_, so the tool continues to suffer from several quirks and performance problems. The latest updates are in pre-release stage after long hiatus. -Because of these issues, you may find you need to troubleshoot the tool itself. While this tutorial covers ``pipenv`` project as a tool for Python *application* development, the abovementioned troubleshooting may necessitate thinking of ``pipenv`` itself as a *library* in development. If you run into a bug that `appears to be addressed `_ by the latest preview version, you may want to try the `latest Pipenv `_. In such a case, you may want to install the pre-release by specifying the version string in `pip` as follows: +Because of these issues, you may find you need to troubleshoot the tool itself. While this tutorial covers ``pipenv`` for Python *application* development, troubleshooting necessitates thinking of ``pipenv`` itself as a *library* in development. If you run into a bug that `appears to be addressed `_ by the latest preview version, you may want to try the `latest Pipenv `_. In such a case, you would install the pre-release by specifying the version string in `pip` as follows: .. code-block:: python From 0d5ca101985d2a08f073b0e2c41a99a9e3e95098 Mon Sep 17 00:00:00 2001 From: Mavaddat Javid Date: Fri, 29 May 2020 01:14:41 -0700 Subject: [PATCH 4/4] remove caveat entirely --- source/tutorials/managing-dependencies.rst | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/source/tutorials/managing-dependencies.rst b/source/tutorials/managing-dependencies.rst index 6602b7a0c..dabeb27cb 100644 --- a/source/tutorials/managing-dependencies.rst +++ b/source/tutorials/managing-dependencies.rst @@ -26,22 +26,6 @@ as Python libraries, should also consider the `poetry `_ project as an alternative dependency management solution. -Recommendation caveats (circa June 2020) ------------------------------------------ - -At present, the ``pipenv`` project team is `staging multiple bug fixes and features `_, so the tool continues to suffer from several quirks and performance problems. The latest updates are in pre-release stage after long hiatus. - -Because of these issues, you may find you need to troubleshoot the tool itself. While this tutorial covers ``pipenv`` for Python *application* development, troubleshooting necessitates thinking of ``pipenv`` itself as a *library* in development. If you run into a bug that `appears to be addressed `_ by the latest preview version, you may want to try the `latest Pipenv `_. In such a case, you would install the pre-release by specifying the version string in `pip` as follows: - -.. code-block:: python - - pip install pipenv==2020.4.1b2 - -Alternatively, project maintainers may want to investigate :ref:`other-dependency-management-tools` for use instead or -alongside ``pipenv``. - -The above caveat on the tutorial will remain until the most recent ``pipenv`` is a stable release. - Installing Pipenv -----------------