Skip to content

Commit 556ce51

Browse files
committed
doc: update requirements and dependencies
Signed-off-by: Emmanuel Blot <emmanuel.blot@free.fr>
1 parent c228f72 commit 556ce51

File tree

3 files changed

+29
-17
lines changed

3 files changed

+29
-17
lines changed

pyftdi/doc/defs.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
.. _FTDI_Recovery: https://www.ftdichip.com/Support/Documents/AppNotes/AN_136%20Hi%20Speed%20Mini%20Module%20EEPROM%20Disaster%20Recovery.pdf
1111
.. _PyFtdi: https://www.github.com/eblot/pyftdi
1212
.. _PyFtdiTools: https://github.com/eblot/pyftdi/tree/master/pyftdi/bin
13+
.. _PyJtagTools: https://www.github.com/eblot/pyjtagtools
1314
.. _FTDI: https://www.ftdichip.com/
1415
.. _PyUSB: https://pyusb.github.io/pyusb/
1516
.. _Python: https://www.python.org/
@@ -29,7 +30,7 @@
2930
.. _PEP_498: https://www.python.org/dev/peps/pep-0498
3031
.. _PEP_526: https://www.python.org/dev/peps/pep-0526
3132
.. _ruamel.yaml: https://pypi.org/project/ruamel.yaml
32-
33+
.. _PyFtdiWin: https://github.com/mariusgreuel/pyftdiwin
3334

3435
.. Restructured Text levels
3536

pyftdi/doc/features.rst

+3
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,9 @@ JTAG API is limited to low-level access. It is not intented to be used for
8484
any flashing or debugging purpose, but may be used as a base to perform SoC
8585
tests and boundary scans.
8686

87+
It requires the PyJtagTools_ Python module which integrates a JTAG engine, while
88+
PyFtdi_ implements the FTDI JTAG backend.
89+
8790
EEPROM
8891
``````
8992

pyftdi/doc/requirements.rst

+24-16
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,15 @@ Requirements
55

66
Python_ 3.9 or above is required.
77

8-
* PyFtdi *v0.55* is the last PyFtdi version to support Python 3.8.
9-
10-
11-
* Python 3.7 has reached end-of-life on June 27rd, 2023.
12-
13-
* PyFtdi *v0.53* is the last PyFtdi version to support Python 3.6.
14-
15-
* Python 3.6 has reached end-of-life on December 23rd, 2021.
16-
17-
* PyFtdi *v0.52* is the last PyFtdi version to support Python 3.5.
18-
19-
* Python 3.5 has reached end-of-life on September 5th, 2020.
20-
218
PyFtdi_ relies on PyUSB_, which itself depends on one of the following native
229
libraries:
2310

2411
* libusb_, currently tested with 1.0.23
2512

26-
PyFtdi_ does not depend on any other native library, and only uses standard
27-
Python modules along with PyUSB_ and pyserial_.
13+
PyFtdi_ does not depend on any other native library. It only uses standard
14+
Python modules, and PyUSB_, pyserial_ and PyJtagTools_.
2815

29-
PyFtdi_ is beeing tested with PyUSB_ 1.1.0.
16+
PyFtdi_ is being tested with PyUSB_ 1.2.1.
3017

3118
Development
3219
~~~~~~~~~~~
@@ -39,6 +26,8 @@ supported platforms. However, M$ Windows is a seamless source of issues and is
3926
not officially supported, although users have reported successful installation
4027
with Windows 7 for example. Your mileage may vary.
4128

29+
A fork of PyFtdi which relies on the official FTDI D2XX Windows library might be
30+
a better solution for Windows users, please check out PyFtdiWin_.
4231

4332
API breaks
4433
~~~~~~~~~~
@@ -52,3 +41,22 @@ new PyFtdi releases. PyFtdi versions up to *v0.39.9* keep a stable API
5241
with *v0.22+* series.
5342

5443
See the *Major Changes* section for details about potential API breaks.
44+
45+
Legacy Python support
46+
~~~~~~~~~~~~~~~~~~~~~
47+
48+
* PyFtdi *v0.55* is the last PyFtdi version to support Python 3.8.
49+
50+
* Python 3.8 has reached end-of-life on October 7th, 2024.
51+
52+
* PyFtdi *v0.54* is the last PyFtdi version to support Python 3.7.
53+
54+
* Python 3.7 has reached end-of-life on June 27rd, 2023.
55+
56+
* PyFtdi *v0.53* is the last PyFtdi version to support Python 3.6.
57+
58+
* Python 3.6 has reached end-of-life on December 23rd, 2021.
59+
60+
* PyFtdi *v0.52* is the last PyFtdi version to support Python 3.5.
61+
62+
* Python 3.5 has reached end-of-life on September 5th, 2020.

0 commit comments

Comments
 (0)