Update CI tools and dependencies

.github/workflows/pytest.yaml

@@ -46,7 +46,6 @@ jobs:
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
-
       #----------------------------------------------
       #       load cached venv if cache exists
       #----------------------------------------------
@@ -74,3 +73,46 @@ jobs:
         run: |
           source .venv/bin/activate
           pytest --cov-report xml:.coverage.xml --cov-report term --cov=ixmp4 -rsx --benchmark-skip
+
+  pre-commit:
+    name: Code quality
+    runs-on: ubuntu-latest
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      #----------------------------------------------
+      #       load cached venv if cache exists
+      #----------------------------------------------
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v2
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      #----------------------------------------------
+      # install dependencies if cache does not exist
+      #----------------------------------------------
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root --with dev,server
+      #----------------------------------------------
+      # install your root project, if required
+      #----------------------------------------------
+      - name: Install library
+        run: poetry install --no-interaction
+      #----------------------------------------------
+      # run pre-commit/(mypy, black, ruff)
+      #----------------------------------------------
+      - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.6.1
+  hooks:
+  - id: mypy
+    entry: bash -c "poetry run mypy ."
+    language: system
+- repo: https://github.com/psf/black
+  rev: 23.10.0
+  hooks:
+  - id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.1.0
+  hooks:
+  - id: ruff

doc/source/devs/ixmp4.core/iamc.rst

@@ -10,6 +10,7 @@ IAMC Data
    :members:
    :undoc-members:
    :show-inheritance:
+   :noindex:
 
 
 .. automodule:: ixmp4.core.iamc.repository

doc/source/devs/ixmp4.core/modules.rst

@@ -6,9 +6,10 @@ Core API (ixmp4.core)
 
    platform
    run
+   model
+   scenario
    iamc
    meta
    region
    unit
    exceptions
-

doc/source/devs/ixmp4.core/scenario.rst

@@ -1,6 +1,6 @@
 
 Scenarios
-=======
+=========
 
 .. toctree::
    :maxdepth: 1

ixmp4/cli/__init__.py

@@ -44,7 +44,7 @@ def login(
     ),
 ):
     try:
-        auth = ManagerAuth(username, password, settings.manager_url)
+        auth = ManagerAuth(username, password, str(settings.manager_url))
         user = auth.get_user()
         utils.good(f"Successfully authenticated as user '{user.username}'.")
         if typer.confirm(

ixmp4/cli/server.py

@@ -15,14 +15,8 @@
 
 @app.command()
 def start(
-    host: Optional[str] = typer.Option(
-        "127.0.0.1",
-        help="The hostname to bind to.",
-    ),
-    port: Optional[int] = typer.Option(
-        9000,
-        help="Requested server port.",
-    ),
+    host: str = typer.Option(default="127.0.0.1", help="The hostname to bind to."),
+    port: int = typer.Option(default=9000, help="Requested server port."),
 ) -> None:
     """Starts the ixmp4 web api."""
     reload = settings.mode != "production"

ixmp4/conf/auth.py

@@ -57,7 +57,7 @@ def get_local_jwt(self):
                 "jti": self.jti,
                 "sub": "ixmp4",
                 "iss": "ixmp4",
-                "user": self.user.dict(),
+                "user": self.user.model_dump(),
             },
             self.secret,
             algorithm="HS256",

ixmp4/conf/manager.py

@@ -30,7 +30,7 @@ class ManagerPlatformInfo(PlatformInfo):
     access_group: int
     url: str
     name: str = Field(alias="slug")
-    notice: str | None
+    notice: str | None = Field(default=None)
 
     class Accessibilty(str, enum.Enum):
         PUBLIC = "PUBLIC"
@@ -101,7 +101,7 @@ def _request(
             params = hashabledict(params)
 
         if json is not None:
-            if type(json) is dict:
+            if isinstance(json, dict):
                 json = hashabledict(json)
             else:
                 json = tuple(json)