Add initial project structure with dependencies and CI configuration

Author: Daandamhuis

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Check on Python Code Quality for 3.10, 3.11, and 3.12
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+        pip install -r requirements.txt
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

README.md

@@ -1 +1,55 @@
-# eboekhouden-client-python
+# Client for E-Boekhouden API
+
+**Introduction:**
+> This package provides a Python client for interacting with the E-Boekhouden API. It simplifies authentication, data fetching, and handling of financial records (cost centers, invoices, ledgers, and mutations) while maintaining clear and organized code. Designed for rapid integration and ease of maintenance, it leverages modern logging and error-handling mechanisms.
+
+## Example for retrieving Mutations
+
+```python
+"""Example script to process the API."""
+
+import logging
+from datetime import datetime, timedelta
+
+from eboekhouden_client import EBoekhoudenClient, DateFilterOperator
+
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+)
+
+log: logging.Logger = logging.getLogger(__name__)
+
+
+def main() -> None:
+    """Main function to process the data pipeline."""
+
+    mutation_details: list = []
+    client = EBoekhoudenClient(
+        credentials={
+            "source": "<Source for the Application>",
+            "access_token": "<Acces Token from the Portal>",
+        },
+    )
+
+    # Determine the processing period (Last 3 Days, including Today)
+    today = datetime.now().date()
+    start_date = today - timedelta(days=3)
+    end_date = today
+
+    # Process the Transactions
+    mutations = client.get_mutations(
+        start_date=start_date.strftime("%Y-%m-%d"),
+        end_date=end_date.strftime("%Y-%m-%d"),
+        date_range=DateFilterOperator.RANGE,
+    )
+
+    for mutation in mutations:
+        mutation_id = mutation.get("id")
+        get_mutation_details = client.get_mutation(mutation_id=mutation_id)
+        mutation_details.append(get_mutation_details)
+
+
+if __name__ == "__main__":
+    main()
+
+```

eboekhouden_client/__init__.py

@@ -0,0 +1,26 @@
+"""This is the main package file for the verbonden_stilte package."""
+
+import logging
+
+from rich.logging import RichHandler
+from .eboekhouden import EBoekhoudenClient
+from .enums import DateFilterOperator
+
+# Version and author info for the package
+__version__ = "2.0-beta"
+__author__ = "Daan Damhuis"
+__organization__ = "Verbonden Stilte"
+
+# Add RichHandler to the root logger
+logging.basicConfig(
+    level="INFO",
+    format="%(message)s",
+    datefmt="[%X]",
+    handlers=[RichHandler(rich_tracebacks=True)],
+)
+
+log = logging.getLogger(__name__)
+
+log.info("Initializing %s version %s", __package__, __version__)
+
+__all__ = ["EBoekhoudenClient", "DateFilterOperator"]