Standardised pyproject.toml and adjusted Makefile.

Also removed unused lines from .readthedocs.yaml.

Author: johnbywater

.github/workflows/runtests.yaml

@@ -51,7 +51,7 @@ jobs:
       run: make install-poetry
 
     - name: Install packages
-      run: make install-packages
+      run: make install
 
     - name: Lint
       run: make lint

.readthedocs.yaml

@@ -1,36 +1,11 @@
 # Read the Docs configuration file for Sphinx projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
-# Required
 version: 2
-
-# Set the OS, Python version and other tools you might need
 build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
-#  jobs:
-#    post_create_environment:
-#      # Install poetry
-#      # https://python-poetry.org/docs/#installing-manually
-#      - POETRY=/home/docs/.local/bin/poetry make install-poetry
-##      - pip install poetry
-#    post_install:
-#      # Install dependencies with 'docs' dependency group
-#      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
-#      # VIRTUAL_ENV needs to be set manually for now.
-#      # See https://github.com/readthedocs/readthedocs.org/pull/11152/
-#      - POETRY=/home/docs/.local/bin/poetry VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH make install-packages
-##      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --extras "crypto" --with docs
-
-#  commands:
-#      - POETRY=/home/docs/.local/bin/poetry make install-poetry
-#      - POETRY=/home/docs/.local/bin/poetry make install
-#      - POETRY=/home/docs/.local/bin/poetry make docs
-#      - ls -l ./docs/_build/html/*
-#      - mkdir --parents $READTHEDOCS_OUTPUT/html/
-#      - cp --recursive ./docs/_build/html/* $READTHEDOCS_OUTPUT/html/
-
   jobs:
     install:
       - python --version
@@ -57,49 +32,8 @@ build:
         - ls -l ./docs/_build/latex/*
         - mkdir -p $READTHEDOCS_OUTPUT/pdf/
         - cp ./docs/_build/latex/eventsourcing.pdf $READTHEDOCS_OUTPUT/pdf/
-#      htmlzip:
-#        - echo "Override default build command for htmlzip format"
-#        - mkdir -p $READTHEDOCS_OUTPUT/htmlzip/
-
-
-
-#  jobs:
-#    pre_create_environment:
-#      # Select Python version (keep in sync with other versions):
-#      - asdf install python 3.11.5
-#      - asdf global python 3.11.5
-#      - python -m pip install --upgrade --no-cache-dir virtualenv
-#
-#      # Install poetry:
-#      - asdf plugin add poetry
-#      - asdf install poetry 1.5.1
-#      - asdf global poetry 1.5.1
-#      - poetry config virtualenvs.create false
-#    post_install:
-#      # Install dependencies with 'docs' dependency group
-#      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
-##      - poetry install --with docs
-#      - make install
-
-# Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-  # builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
-
-# Optionally build your docs in additional formats such as PDF and ePub
 formats:
     - pdf
     - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-#python:
-#  install:
-#    - method: pip
-#      path: .
-#      extra_requirements:
-#        - docs

Makefile

@@ -22,18 +22,35 @@ python-version:
 
 .PHONY: install
 install:
-	$(POETRY) sync --extras "crypto cryptography" --with "docs" -vv $(opts)
+	$(POETRY) sync --all-extras --with "docs" $(opts)
 
-.PHONY: install-packages
-install-packages:
-	$(POETRY) sync --no-root --extras "crypto cryptography" --with "docs" -vv $(opts)
+.PHONY: update
+update: update-lock install
 
-.PHONY: poetry-update
-poetry-update:
-	$(POETRY) update
+.PHONY: update-lock
+update-lock:
+	$(POETRY) update --lock -v
+
+
+.PHONY: fmt
+fmt: fmt-isort fmt-black
+
+.PHONY: fmt-ruff
+fmt-ruff:
+	$(POETRY) run ruff check --fix eventsourcing tests examples
+
+.PHONY: fmt-ruff-unsafe
+fmt-ruff-unsafe:
+	$(POETRY) run ruff --fix --unsafe-fixes eventsourcing
+
+.PHONY: fmt-black
+fmt-black:
+	$(POETRY) run black eventsourcing tests examples
+
+.PHONY: fmt-isort
+fmt-isort:
+	$(POETRY) run isort eventsourcing tests examples
 
-.PHONY: update
-update: poetry-update install-packages
 
 .PHONY: lint
 lint: lint-black lint-ruff lint-isort lint-mypy lint-pyright #lint-dockerfile
@@ -68,26 +85,6 @@ lint-mypy:
 # 	@docker run --rm -i replicated/dockerfilelint:ad65813 < ./dev/Dockerfile_eventsourcing_requirements
 #
 
-.PHONY: fmt
-fmt: fmt-isort fmt-black
-
-.PHONY: fmt-ruff
-fmt-ruff:
-	$(POETRY) run ruff check --fix eventsourcing tests examples
-
-.PHONY: fmt-ruff-unsafe
-fmt-ruff-unsafe:
-	$(POETRY) run ruff --fix --unsafe-fixes eventsourcing
-
-.PHONY: fmt-black
-fmt-black:
-	$(POETRY) run black eventsourcing tests examples
-
-.PHONY: fmt-isort
-fmt-isort:
-	$(POETRY) run isort eventsourcing tests examples
-
-
 
 .PHONY: test
 test: coveragetest coverage100 timeit

docs/topics/installing.rst

@@ -157,20 +157,22 @@ fork and clone the GitHub repository.
 Once you have cloned the project's GitHub repository, change into the root folder,
 or open the project in an IDE. You should see a Makefile.
 
-If you don't already have Poetry installed, run `make install-poetry`.
+If you don't already have the required version of Poetry installed, running
+`make install-poetry` will install it with pipx, using a suffix to indicate
+the version e.g. 'poetry@2.1.2'.
 
 ::
 
     $ make install-poetry
 
 
-Run `make install-packages` to create a new virtual environment and
-install packages that are needed for development, such as Sphinx, Coverage.py, Black,
-mypy, ruff, and isort.
+Run `make install` to create a new virtual environment and install packages that
+are needed for development, such as sphinx, coverage, black, ruff, isort, mypy,
+and pyright.
 
 ::
 
-    $ make install-packages
+    $ make install
 
 
 Once installed, check the project's test suite passes by running `make test`.
@@ -200,20 +202,20 @@ and user. You may prefer to run PostgreSQL in a Docker container.
     postgres=# CREATE SCHEMA myschema AUTHORIZATION eventsourcing;
 
 
-Check the syntax and static types are correct by running `make lint`.
+The code can be automatically reformatted using the following command
+(which uses isort and Black). Ruff and mypy errors will often need
+to be fixed by hand.
 
 ::
 
-    $ make lint
+    $ make fmt
 
 
-The code can be automatically reformatted using the following command
-(which uses isort and Black). Ruff and mypy errors will often need
-to be fixed by hand.
+Check the syntax and static types are correct by running `make lint`.
 
 ::
 
-    $ make fmt
+    $ make lint
 
 
 You can build the docs (and check they build) with `make docs`.
@@ -224,3 +226,7 @@ You can build the docs (and check they build) with `make docs`.
 
 Before submitting Pull Requests on GitHub, please make sure everything is working
 by running `make docs lint test`.
+
+::
+
+    $ make docs lint test