Merge pull request #4 from ADACS-Australia/refactor/base

Change the way the dependency groups are managed.  No longer using ex…

.github/workflows/pull_request.yml

@@ -101,7 +101,7 @@ jobs:
 
       # Install the project (we need some of the tools installed here for liniting etc)
       - name: Install the project
-        run: poetry install --no-interaction --extras "docs dev"
+        run: poetry install --no-interaction
 
       # Enforce code formating standards
       # note: --config is needed to prevent ruff from using a version elsewhere in the project.

.readthedocs.yml

@@ -13,7 +13,7 @@ build:
       - pip install poetry
     post_install:
       # Install project and dependencies with 'docs' dependency group.
-      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --only main,docs
       # Generate API documentation, etc. (if needed)
       - make -f docs/Makefile content
 sphinx:

README.md

@@ -35,7 +35,7 @@ and answer the questions:
 ### Install the new project
 Create and activate a new virtual environment (**use Python version >= 3.11**) using your favourite method (if you don't know how to use Python environments, we advise you to go learn about them now) and install the project by running the following in the new repo directory:
 ``` console
-poetry install --all-extras
+poetry install
 ```
 
 ### Configure the services you need

docs/content/notes_for_developers.md

@@ -71,10 +71,10 @@ Poetry is used to manage this project ([see here for an introduction](https://py
 
 ## Installing Development Dependencies
 
-Once the code is locally installed, development dependencies should be installed by moving to the project's root directory and executing the following:
+Once the code is locally installed, dependencies should be installed by moving to the project's root directory and executing the following:
 
 ``` console
-$ poetry install --all-extras
+$ poetry install
 ```
 
 In what follows, it will be assumed that this has been done.

hooks/post_gen_project.py

@@ -97,7 +97,7 @@ def install(venv_type: str) -> None:
         String specifying how the virtual environment is being supported
     """
     if venv_type in ["venv", "poetry", "pyenv"]:
-        result = subprocess.run(["poetry", "install", "--all-extras"])
+        result = subprocess.run(["poetry", "install", "--no-interaction"])
     elif venv_type == "none":
         pass
     else: