diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2021-01-28 20:47:05 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-28 20:47:05 -0500 |
| commit | d5cebaef06719fdc01eba15e01fb70ef948e05c9 (patch) | |
| tree | 7cd0010127ae50250e0843cab31540ec05e5806d /docs | |
| parent | 44eb9d4e1946a3cc9a10fe85ccb617b6076f627c (diff) | |
| parent | a96c0f53b2a62a94582624c76c7d990012891204 (diff) | |
| download | cmd2-git-d5cebaef06719fdc01eba15e01fb70ef948e05c9.tar.gz | |
Merge pull request #1046 from KyleKing/patch-1
Update conditional pyreadline3 dependency for Win
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/overview/integrating.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst index db5cb206..041083bc 100644 --- a/docs/overview/integrating.rst +++ b/docs/overview/integrating.rst @@ -26,10 +26,13 @@ Windows Considerations If you would like to use :ref:`features/completion:Completion`, and you want your application to run on Windows, you will need to ensure you install the -``pyreadline`` package. Make sure to include the following in your -``setup.py``:: +``pyreadline3`` or ``pyreadline`` package. Make sure to include the following +in your ``setup.py``:: install_requires=[ 'cmd2>=1,<2', - ":sys_platform=='win32'": ['pyreadline'], + ":sys_platform=='win32'": [ + "pyreadline ; python_version<'3.8'", + "pyreadline3 ; python_version>='3.8'", # pyreadline3 is a drop-in replacement for Python 3.8 and above + ], ] |