feat: set up custom exceptions (#108)

Fixes #71

Author: afuetterer

.pre-commit-config.yaml

@@ -60,7 +60,7 @@ repos:
   hooks:
   - id: mdformat
     args: [--number, --wrap=120, --ignore-missing-references]
-    exclude: CHANGELOG.md|.changelog.md|docs/src/cli.md
+    exclude: CHANGELOG.md|.changelog.md|docs/src/cli.md|docs/src/exceptions.md
     additional_dependencies:
     - mdformat-mkdocs[recommended]>=v2.0.7
 

docs/mkdocs.yml

@@ -17,6 +17,7 @@ nav:
 - Home: index.md
 - Reference:
   - API Reference: api.md
+  - Exceptions: exceptions.md
   - Command Line Interface: cli.md
 - Meta:
   - Contributor Guide: contributing.md

docs/src/exceptions.md

@@ -0,0 +1,3 @@
+# Exceptions
+
+::: re3data._exceptions

src/re3data/__init__.py

@@ -6,10 +6,13 @@
 
 from re3data.__about__ import __version__
 from re3data._client import Client
+from re3data._exceptions import Re3dataError, RepositoryNotFoundError
 
 __all__ = [
     "__version__",
     "Client",
+    "Re3dataError",
+    "RepositoryNotFoundError",
 ]
 
 _client = Client()

src/re3data/_exceptions.py

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2024 Heinz-Alexander Fütterer
+#
+# SPDX-License-Identifier: MIT
+
+"""The _exceptions module defines exception classes for handling error scenarios encountered when using the re3data API.
+
+Classes:
+    Re3dataError: Base exception class for errors related to the re3data API.
+    RepositoryNotFoundError: Exception raised when a repository is not found.
+"""
+
+
+class Re3dataError(Exception):
+    """Base exception class for errors related to the re3data API."""
+
+
+class RepositoryNotFoundError(Re3dataError):
+    """Exception raised when a repository is not found."""