Merge branch 'ruff_pyright_day' of https://github.com/ISISComputingGroup/lewis into ruff_pyright_day

Author: Jack Doughty

.pre-commit-config.yaml

@@ -1,42 +1,28 @@
-Contributing to Lewis
-=====================
-
+# Contributing to Lewis
 Contributions to Lewis are always welcome and there are different ways of
 contributing to the framework. We aim to respond to all communications within
 one working day.
 
 
-Reporting Issues
-----------------
-
+## Reporting Issues
 If you run into any issues or bugs while using Lewis or find the documentation
 of a feature unclear, you can help us improve Lewis by
-`opening an Issue <https://github.com/ess-dmsc/lewis/issues/new>`__
-here on GitHub. Please be sure to include enough information to reproduce the
+opening an issue here on GitHub. Please be sure to include enough information to reproduce the
 issue.
 
-If you've already created a fix, you can also directly
-`submit a Pull Request <#submitting-pull-requests>`__.
-
-
-Requesting Features
--------------------
+If you've already created a fix, you can also directly submit a pull request.
 
+## Requesting Features
 If a feature you want is missing from Lewis, feel free to
-`open an Issue <https://github.com/ess-dmsc/lewis/issues/new>`__
-here on GitHub to request it. Please describe the context and the expected
+open an issue here on GitHub to request it. Please describe the context and the expected
 behaviour in detail.
 
 If you've already implemented a new feature and would like to submit it, you
-can also directly `submit a Pull Request <#submitting-pull-requests>`__.
+can also directly submit a pull request.
 
-
-Submitting Pull Requests
-------------------------
-
-We are happy to accept contributed Pull Requests from forks. Please read through the
-`developer guide <http://lewis.readthedocs.io/en/latest/developer_guide/index.html>`__
-to get started.
+## Submitting Pull Requests
+We are happy to accept contributed pull requests from forks. Please read through the
+developer guide to get started.
 
 If your Pull Request addresses any open Issues, please reference them with a
 line that reads:
@@ -49,14 +35,10 @@ The Pull Request description should detail the purpose of the Pull Request, and
 where appropriate should include some instructions on how to test the changes.
 
 Please ensure your Pull Request passes all integration tests and is able to be
-merged with master automatically.
+merged with the main branch automatically.
 
 
-Submitting Devices
-------------------
-
+## Submitting Devices
 If you have a device you would like to contribute to the main repository, we
 are happy to accept these as a Pull Request as well. Please see the
-documentation for details on
-`how to write a device simulator <http://lewis.readthedocs.io/en/latest/developer_guide/writing_devices.html>`__.
-
+documentation for details on how to write a device simulator.

CONTRIBUTING.rst CONTRIBUTING.mdCONTRIBUTING.rst renamed to CONTRIBUTING.md

@@ -52,7 +52,7 @@ builders = pipeline_builder.createBuilders { container ->
    pipeline_builder.stage("${container.key}: Test") {
       def test_output = "TestResults.xml"
       container.sh """
-        pyenv local 3.7 3.8 3.9 
+        pyenv local 3.7 3.8 3.9 3.10 3.11
         cd ${project}
         python -m tox -- --junitxml=${test_output}
       """

Jenkinsfile

@@ -1,27 +1,26 @@
-|Lewis|
-=======
-
+# Lewis
 Lewis - Let's write intricate simulators.
 
 Lewis is a Python framework for simulating hardware devices. It is
-compatible with Python 3.6 or higher.
+compatible with Python 3.7 to 3.11.
+
+It is currently not compatible with 3.12 as the asyncchat module has been removed from Python.
+We are going to fix this at some point.
 
 Lewis can be installed via pip or ran from source. See relevant usage sections of the docs for more details.
 
 Resources:
-`GitHub <https://github.com/ess-dmsc/lewis>`__ --
-`PyPI <https://pypi.python.org/pypi/lewis>`__
+[GitHub](https://github.com/ess-dmsc/lewis)
+[PyPI](https://pypi.python.org/pypi/lewis)
 
 Lewis was previously named "Plankton" but, due to a
 package with the same name on PyPI, we decided to rename the project.
 
 Lewis is licensed under GPL v3 or later.
 
-Purpose and Use Cases
----------------------
-
+## Purpose and Use Cases
 Lewis is being developed in the context of instrument control at the
-`ESS <http://europeanspallationsource.se>`__, but it is general enough
+[ESS](http://europeanspallationsource.se), but it is general enough
 to be used in many other contexts that require detailed, stateful
 software simulations of hardware devices.
 
@@ -38,7 +37,6 @@ replication and allows the developer of a simulated device to focus on
 capturing device behaviour.
 
 Potential use cases for detailed device simulators include:
-
 -  Replacing the physical device when developing and testing software
    that interfaces with the device
 -  Testing failure conditions without risking damage to the physical
@@ -52,12 +50,8 @@ Using a simulation for the above has the added benefit that, unlike most
 real devices, a simulation may be sped up / fast-forwarded past any
 lengthy delays or processes that occur in the device.
 
-Features
---------
-
-Brief Terminology
-~~~~~~~~~~~~~~~~~
-
+## Features
+### Brief Terminology
 ``Device``\ s and ``Interface``\ s are two independent concepts in
 Lewis. The ``Device`` is model for the device behaviour and internal
 memory. A ``Device`` can be represented using a ``StateMachine``, but it
@@ -69,11 +63,7 @@ by Lewis. The ``Device`` and ``Interface`` are instantiated as part of a
 ``Simulation`` that provides a cycle "heart beat" and manages other
 environmental aspects and services.
 
-.. image:: https://github.com/ess-dmsc/lewis/raw/master/docs/resources/diagrams/SimulationCycles.png
-
-What Can You Do With Lewis?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+### What Can You Do With Lewis?
 -  Create new ``Device``\ s to closely imitate the internal behaviour
    and memory of something
 -  Optionally make a ``Device`` work as a ``StateMachine`` via
@@ -86,4 +76,4 @@ What Can You Do With Lewis?
 -  Control server can be accessed via command-line utility, Python bindings, or
    JSON RPC.
 
-.. |Lewis| image:: https://github.com/ess-dmsc/lewis/raw/master/docs/resources/logo/lewis-logo.png
+[Getting started](docs/quickstart.md)