Skip to content

Commit 4ab0244

Browse files
authored
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.
1 parent cdda776 commit 4ab0244

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

source/tutorials/managing-dependencies.rst

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,22 @@ as Python libraries, should also consider the
2626
`poetry <https://github.com/python-poetry/poetry>`_ project as an alternative dependency
2727
management solution.
2828

29+
Recommendation caveats (circa June 2020)
30+
-----------------------------------------
31+
32+
At present, the ``pipenv`` project team is `staging multiple bug fixes and features <https://github.com/pypa/pipenv/issues/3369>`_, 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.
33+
34+
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 <https://github.com/pypa/pipenv/releases/latest>`_ by the latest preview version, you may want to try the `latest Pipenv <https://pypi.org/project/pipenv/#history>`_. In such a case, you may want to install the pre-release by specifying the version string in `pip` as follows:
35+
36+
.. code-block:: python
37+
38+
pip install pipenv==2020.4.1b2
39+
40+
Alternatively, project maintainers may want to investigate :ref:`other-dependency-management-tools` for use instead or
41+
alongside ``pipenv``.
42+
43+
The above caveat on the tutorial will remain until the most recent ``pipenv`` is a stable release.
44+
2945
Installing Pipenv
3046
-----------------
3147

@@ -41,12 +57,6 @@ Use ``pip`` to install Pipenv:
4157
4258
pip install --user pipenv
4359
44-
At present, the `latest Pipenv <https://pypi.org/project/pipenv/#history>`_ is in pre-release stage after a long hiatus. If you run into a bug that `appears to be addressed <https://github.com/pypa/pipenv/releases/latest>`_ by the latest preview version, you may want to try installing the pre-release by specifying the version in `pip` as follows:
45-
46-
.. code-block:: python
47-
48-
pip install pipenv==2020.4.1b2
49-
5060
.. _pipenv-user-base:
5161

5262
.. Note:: This does a `user installation`_ to prevent breaking any system-wide

0 commit comments

Comments
 (0)