Skip to content

Commit

Permalink
readme: deduplicate requirement version specification (#452)
Browse files Browse the repository at this point in the history
* readme: use code block for shell command

ReStructured Text has a specific syntax to specify code blocks [1]. Use
that so renderers can display its content nicely.

[1] https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#literal-blocks

* readme: deduplicate requirement version specification

Specifying the dependency versions in the README file creates an extra
maintenance burden not worth the effort. In fact, it has been left
outdated more than once leading to misinformation [1, 2, 3]. Instead,
provide the rough information in the documentation and point users to
the source of truth for details.

Python 3 is still listed explicitly since it won't be bumped every now
and then, and provides a useful compatibility information for users.
Unfortunately, PyVISA cannot be dealt with in a similar vein.

[1] dd8e904 ("switch to a PEP517 install")
[2] 8a0753b ("bump Python requirement to 3.8 and PyVISA requirement to 1.13")
[3] 29d3048 ("Drop support for Python 3.8 and 3.9 and add support for Python 3.13")
  • Loading branch information
henriquesimoes authored Sep 24, 2024
1 parent 478647b commit 7e25798
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ controlling:
Requirements
------------

- Python (tested with 3.6+)
- PyVISA 1.11+
- Python 3
- PyVISA

Optionally:

Expand All @@ -74,11 +74,13 @@ Optionally:
- zeroconf (for HiSLIP and VICP devices discovery)
- pyvicp (to enable the Teledyne LeCroy proprietary VICP protocol)

Please refer to `pyproject.toml <./pyproject.toml>`_ for the specific version
requirements.

Installation
--------------

Using pip:
Using pip::

$ pip install pyvisa-py

Expand Down

0 comments on commit 7e25798

Please sign in to comment.