Release v0.2.2

.github/workflows/ci.yml

@@ -107,6 +107,7 @@ jobs:
         pdm run -v lint
         pdm install -v -dGtest --no-self --no-isolation
         pdm run -v pytest
+        sleep 10
         pdm run -v doctests
 
     - name: Upload coverage reports to Codecov

CONTRIBUTING.md

@@ -6,8 +6,8 @@ Contributors and contributions are welcome. Please read these guidelines first.
 
 The project homepage is on [GitHub](https://github.com/sr-murthy/fsrapiclient).
 
-Contributors can open pull requests from a fork targeting the parent [main branch](https://github.com/sr-murthy/fsrapiclient/tree/main). But it may be a good first step to create an [issue](https://github.com/sr-murthy/fsrapiclient/issues) or open a
-[discussion topic](https://github.com/sr-murthy/fsrapiclient/discussions).
+Contributors can open pull requests from a fork targeting the parent [main branch](https://github.com/sr-murthy/fsrapiclient/tree/main). But it may be a good first step to create an
+[issue](https://github.com/sr-murthy/fsrapiclient/issues) or open a [discussion topic](https://github.com/sr-murthy/fsrapiclient/discussions).
 
 A simple Git workflow, using a feature and/or fix branch created off the `main` branch of your fork, is recommended.
 
@@ -42,7 +42,7 @@ git clone git+ssh://[email protected]/<fork user>/fsrapiclient
 
 You can create additional remotes for the parent project to enable easier syncing, or you can simply create PRs directly against the parent project.
 
-## Dependencies & PDM `cubes`
+## Dependencies & PDM
 
 The package only depends on the [requests](https://requests.readthedocs.io/en/latest/) library.
 
@@ -92,12 +92,11 @@ pdm export -v -f requirements --dev -o requirements.txt
 
 For more information on PDM lockfiles and installing requirements see the [PDM documentation](https://pdm-project.org/latest/).
 
-## Tests `microscope`
+## Tests
 
 Tests are defined in the `tests` folder, and should be run with [pytest](https://pytest-cov.readthedocs.io/en/latest/).
 
-For convenience different types of test targets are defined in the[Makefile](https://github.com/sr-murthy/fsrapiclient/blob/main/Makefile): lint` for Ruff linting, `doctests` for running [doctests](https://docs.python.org/3/library/doctest.html) and
-`unittests` for running unittests and measuring coverage, using `pytest` and the `pytest-cov` plugin:
+For convenience different types of test targets are defined in the [Makefile](https://github.com/sr-murthy/fsrapiclient/blob/main/Makefile): `lint` for Ruff linting, `doctests` for running [doctests](https://docs.python.org/3/library/doctest.html) and `unittests` for running unittests and measuring coverage, using `pytest` and the [pytest-cov](https://pytest-cov.readthedocs.io/en/latest/) plugin:
 
 ``` shell
 make lint
@@ -107,8 +106,7 @@ make doctests
 
 Linting warnings should be addressed first, and any changes staged and committed.
 
-Unit tests can be run all at once using `make unittests` or individually using `pytest`, e.g. running the test class for the
-`~fsrapiclient.api.FsrApiClient` class:
+Unit tests can be run all at once using `make unittests` or individually using `pytest`, e.g. running the test class for the `~fsrapiclient.api.FsrApiClient` class:
 
 ``` shell
 python -m pytest -sv tests/units/test_api.py::TestFsrApiClient
@@ -120,19 +118,20 @@ The doctests serve as acceptance tests, and are best run after the unit tests. T
 python -m doctest -v src/fsrapiclient/api.py
 ```
 
-## Documentation `book`
+## Documentation
 
-Detailed documentation can be found [here](https://fsrapiclient.readthedocs.io).
+This documentation site is written, built and deployed using [reStructuredText](https://docutils.sourceforge.io/rst.html),
+[Sphinx](https://www.sphinx-doc.org/en/master/), and [Read the Docs (RTD)](https://readthedocs.org/) respectively. The Sphinx theme used is [Furo](https://github.com/pradyunsg/furo).
 
-## CI `circle-play`
+## CI
 
 The CI pipelines are defined in the [CI YML](https://github.com/sr-murthy/fsrapiclient/blob/main/.github/workflows/ci.yml)
 and the [CodeQL Analysis YML](https://github.com/sr-murthy/fsrapiclient/blob/main/.github/workflows/codeql-analysis.yml). Currently, pipelines for all branches include a tests stage that includes Ruff linting, unit tests, Python doctests, and in that order.
 
-## Versioning and Releases `upload`
+## Versioning and Releases
 
-The [PyPI package](https://pypi.org/project/fsrapiclient/) is currently at version `0.2.1`.
+The [PyPI package](https://pypi.org/project/fsrapiclient/) is currently at version `0.2.2`.
 
 There is currently no dedicated pipeline for releases - both [GitHub releases](https://github.com/sr-murthy/fsrapiclient/releases) and [PyPI packages](https://pypi.org/project/fsrapiclient) are published manually, but both have the same version tag.
 
-Pipelines for releases will be added as part of a future release.
+A separate release pipeline may be added as part of a future release.

README.md

@@ -19,6 +19,8 @@
 
 A lightweight Python client library for the UK [Financial Services Register](https://register.fca.org.uk/s/) [RESTful API](https://register.fca.org.uk/Developer/s/).
 
+The [PyPI package](https://pypi.org/project/fsrapiclient) is currently at version `0.2.2`.
+
 The Financial Services Register, or FS Register, is a **public** database of all firms, individuals, funds, and other entities, that are either currently, or have been previously, authorised and/or regulated by the UK [Financial Conduct Authority (FCA)](https://www.fca.org.uk) and/or the [Prudential Regulation Authority (PRA)](http://bankofengland.co.uk/pra).
 
 > [!NOTE]

docs/index.rst

@@ -1,10 +1,16 @@
+.. meta::
+
+   :google-site-verification: 3F2Jbz15v4TUv5j0vDJAA-mSyHmYIJq0okBoro3-WMY
+
 ============
 fsrapiclient
 ============
 
-A lightweight Python client library and package for the UK `Financial Services Register (FS Register) <https://register.fca.org.uk/s/>`_ `RESTful API <https://register.fca.org.uk/Developer/s/>`_.
+A lightweight Python client library for the UK `Financial Services Register <https://register.fca.org.uk/s/>`_ `RESTful API <https://register.fca.org.uk/Developer/s/>`_.
+
+The `PyPI package <https://pypi.org/project/fsrapiclient>`_ is currently at version `0.2.1`.
 
-The FS Register is a **public** database of all firms, individuals, funds, and other entities, that are either currently, or have been previously, authorised and/or regulated by the UK `Financial Conduct Authority (FCA) <https://www.fca.org.uk>`_ and/or the `Prudential Regulation Authority (PRA) <http://bankofengland.co.uk/pra>`_.
+The Financial Services Register, or FS Register, is a **public** database of all firms, individuals, funds, and other entities, that are either currently, or have been previously, authorised and/or regulated by the UK `Financial Conduct Authority (FCA) <https://www.fca.org.uk>`_ and/or the `Prudential Regulation Authority (PRA) <http://bankofengland.co.uk/pra>`_.
 
 .. note::
 

docs/sources/api-reference.rst

@@ -1,3 +1,7 @@
+.. meta::
+
+   :google-site-verification: 3F2Jbz15v4TUv5j0vDJAA-mSyHmYIJq0okBoro3-WMY
+
 :html_theme.sidebar_secondary.remove:
 
 =============

docs/sources/contributing.rst

@@ -1,3 +1,7 @@
+.. meta::
+
+   :google-site-verification: 3F2Jbz15v4TUv5j0vDJAA-mSyHmYIJq0okBoro3-WMY
+
 ============
 Contributing
 ============
@@ -112,7 +116,7 @@ Tests :fas:`microscope`
 Tests are defined in the ``tests`` folder, and should be run with `pytest <https://pytest-cov.readthedocs.io/en/latest/>`_.
 
 For convenience different types of test targets are defined in the `Makefile <https://github.com/sr-murthy/fsrapiclient/blob/main/Makefile>`_: ``lint`` for Ruff linting, ``doctests`` for running `doctests <https://docs.python.org/3/library/doctest.html>`_ and
-``unittests`` for running unittests and measuring coverage, using :program:`pytest` and the ``pytest-cov`` plugin:
+``unittests`` for running unittests and measuring coverage, using :program:`pytest` and the `pytest-cov <https://pytest-cov.readthedocs.io/en/latest/>`_ plugin:
 
 .. code:: shell
 
@@ -139,7 +143,7 @@ The doctests serve as acceptance tests, and are best run after the unit tests. T
 Documentation :fas:`book`
 =========================
 
-Detailed documentation can be found `here <https://fsrapiclient.readthedocs.io>`_.
+This documentation site is written, built and deployed using `reStructuredText <https://docutils.sourceforge.io/rst.html>`_, `Sphinx <https://www.sphinx-doc.org/en/master/>`_, and `Read the Docs (RTD) <https://readthedocs.org/>`_ respectively. The Sphinx theme used is `Furo <https://github.com/pradyunsg/furo>`_.
 
 .. _contributing.ci:
 
@@ -154,8 +158,8 @@ and the `CodeQL Analysis YML <https://github.com/sr-murthy/fsrapiclient/blob/mai
 Versioning and Releases :fas:`upload`
 =====================================
 
-The `PyPI package <https://pypi.org/project/fsrapiclient/>`_ is currently at version ``0.2.1``.
+The `PyPI package <https://pypi.org/project/fsrapiclient/>`_ is currently at version ``0.2.2``.
 
 There is currently no dedicated pipeline for releases - both `GitHub releases <https://github.com/sr-murthy/fsrapiclient/releases>`_ and `PyPI packages <https://pypi.org/project/fsrapiclient>`_ are published manually, but both have the same version tag.
 
-Pipelines for releases will be added as part of a future release.
+A separate release pipeline may be added as part of a future release.