Merge pull request #317 from ISISComputingGroup/modernise_lewis

add github action, create pyproject.toml, remove some ess specific st…

Author: rerpha

.flake8

@@ -0,0 +1,38 @@
+name: Lint-and-test
+on: [pull_request, workflow_call]
+jobs:
+  call-linter-workflow:
+    uses: ISISComputingGroup/reusable-workflows/.github/workflows/linters.yml@main
+    with:
+      compare-branch: origin/main
+      python-ver: '3.11'
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ['3.10','3.11']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.version }}
+      - name: install requirements
+        run: pip install -e .[dev]
+      - name: run unit tests
+        run: python -m pytest .
+      - name: run system tests
+        working-directory: ./system_tests
+        run: python -m pytest --approvaltests-use-reporter='PythonNativeReporter' lewis_tests.py 
+  results:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: Final Results
+    needs: [call-linter-workflow, tests]
+    steps:
+    - run: exit 1
+      # see https://stackoverflow.com/a/67532120/4907315
+      if: >-
+          ${{
+               contains(needs.*.result, 'failure')
+            || contains(needs.*.result, 'cancelled')
+          }}

.github/workflows/Lint-and-test.yml

@@ -0,0 +1,8 @@
+name: sphinx
+
+on: [push, pull_request, workflow_call]
+
+jobs:
+  call_sphinx_builder:
+    uses: ISISComputingGroup/reusable-workflows/.github/workflows/sphinx.yml@main
+    secrets: inherit

.github/workflows/documentation.yml

@@ -5,6 +5,10 @@
 .cache
 dist/
 build/
-docs/_build/
+doc/_build/
 lewis.egg-info
 .DS_Store
+.venv
+doc/generated
+_build
+.approval_tests_temp

.gitignore

@@ -2,15 +2,15 @@
 Lewis - Let's write intricate simulators.
 
 Lewis is a Python framework for simulating hardware devices. It is
-compatible with Python 3.7 to 3.11.
+compatible with Python 3.10 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)
+[GitHub](https://github.com/ISISComputingGroup/lewis)
 [PyPI](https://pypi.python.org/pypi/lewis)
 
 Lewis was previously named "Plankton" but, due to a

.isort.cfg

@@ -0,0 +1,11 @@
+:orphan:
+
+API
+===
+
+.. autosummary::
+   :toctree: generated
+   :template: custom-module-template.rst
+   :recursive:
+
+   lewis

Jenkinsfile

@@ -0,0 +1,40 @@
+
+
+{{ ('``' + fullname + '``') | underline }}
+
+{%- set filtered_members = [] %}
+{%- for item in members %}
+    {%- if item in functions + classes + exceptions + attributes %}
+        {% set _ = filtered_members.append(item) %}
+    {%- endif %}
+{%- endfor %}
+
+.. automodule:: {{ fullname }}
+    :members:
+    :show-inheritance:
+
+    {% block modules %}
+    {% if modules %}
+    .. rubric:: Submodules
+
+    .. autosummary::
+        :toctree:
+        :template: custom-module-template.rst
+        :recursive:
+    {% for item in modules %}
+        {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block members %}
+    {% if filtered_members %}
+    .. rubric:: Members
+
+    .. autosummary::
+        :nosignatures:
+    {% for item in filtered_members %}
+        {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}

README.md

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# lewis documentation build configuration file, created by
+# sphinx-quickstart on Wed Nov  9 16:42:53 2016.
+import os
+import sys
+sys.path.insert(0, os.path.abspath("../lewis"))
+
+
+# -- General configuration ------------------------------------------------
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    # and making summary tables at the top of API docs
+    "sphinx.ext.autosummary",
+    # This can parse google style docstrings
+    "sphinx.ext.napoleon",
+    # For linking to external sphinx documentation
+    "sphinx.ext.intersphinx",
+    # Add links to source code in API docs
+    "sphinx.ext.viewcode",
+]
+templates_path = ["_templates"]
+# General information about the project.
+project = u"lewis"
+language = 'en'
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+# -- Options for HTML output ---------------------------------------------
+suppress_warnings =["docutils"]
+html_theme = "sphinx_rtd_theme"
+html_logo = "resources/logo/lewis-logo.png"
+
+autoclass_content = "both"
+myst_heading_anchors = 3
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True