Skip to content

Commit 9893a9c

Browse files
author
Jason McFarland
committed
2 parents 7a4d342 + e6f432a commit 9893a9c

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ Also review the documentation and guides available on the
1919

2020
## Requirements
2121

22-
The new cbapi is designed to work on Python 2.6.6 and above (including 3.x).
22+
The new cbapi is designed to work on Python 2.6.6 and above (including 3.x). If you're just starting out,
23+
we recommend using the latest version of Python 3.6.x or above.
24+
2325
All requirements are installed as part of `pip install`.
2426
The legacy cbapi (`cbapi.CbApi`) and legacy bit9api (`cbapi.bit9Api`) are still compatible with Python 2.x only.
2527

docs/_static/install-windows.png

100644100755
24.8 KB
Loading

docs/installation.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,35 @@ If you already have Python installed, you can skip right down to "Using Pip".
1313
Installing Python
1414
-----------------
1515

16-
Obviously the first thing you’ll need to do is install Python on your workstation or server. For best compatibility,
17-
install the latest version of Python 2.7 (as of this writing, that is version 2.7.11). Linux and Mac OS X systems will
18-
most likely have Python installed; it will have to be installed on Windows separately.
16+
Obviously the first thing you’ll need to do is install Python on your workstation or server. We recommend
17+
using the latest version of Python 3 (as of this writing, 3.6.4) for maximum performance and compatibility.
18+
Linux and Mac OS X systems will most likely have Python installed; it will have to be installed on Windows separately.
1919

2020
Note that cbapi is compatible with both Python 2.7 and Python 3.x. If you already have Python 3 installed on your
2121
system, you're good to go!
2222

2323
If you believe you have Python installed already, run the following two commands at a command prompt::
2424

2525
$ python --version
26-
Python 2.7.10
26+
Python 3.6.4
2727

2828
$ pip --version
29-
pip 7.1.2 from /Users/jgarman/Desktop/Reno/homebrew/lib/python2.7/site-packages (python 2.7)
29+
pip 9.0.1 from /usr/local/lib/python3.6/site-packages (python 3.6)
3030

3131
If “python” reports back a version of 2.6.x, 2.7.x, or 3.x.x, you’re in luck.
3232
If “pip” is not found, don’t worry, we’ll install that shortly.
3333

3434
If you're on Windows, and Python is not installed yet, download the latest Python installer from the python.org website.
35-
The direct link for the Python 2.7.11 installer for Windows 64-bit platforms is
36-
https://www.python.org/ftp/python/2.7.11/python-2.7.11.amd64.msi.
35+
We recommend using the latest version of Python 3. As of this writing, the latest version available is 3.6.4.
36+
The direct link for the Python 3.6.4 installer for Windows 64-bit platforms is
37+
https://www.python.org/ftp/python/3.6.4/python-3.6.4-amd64.exe.
3738

3839
.. image:: _static/install-windows.png
3940
:alt: Windows installation options showing "Add python.exe to path"
4041
:align: right
4142

42-
Install the MSI for "all users" and in the configuration options ensure that the "Add python.exe to Path" option is
43-
installed (you will have to scroll to the end of the customization options to find this).
43+
Ensure that the "Add Python to PATH" option is
44+
checked.
4445

4546
If for some reason you do not have pip installed, follow the instructions at this
4647
`handy guide <http://docs.python-guide.org/en/latest/starting/installation/>`_.

0 commit comments

Comments
 (0)