Merged current dev into feature branch, #48

.github/workflows/run-tests.yaml

@@ -73,29 +73,3 @@ jobs:
         run: poetry run safety check
       - name: Run mypy
         run: poetry run mypy src
-  generate-doc:
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [3.10.2]
-        poetry-version: [1.1.13]
-        os: [ubuntu-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Run poetry image
-        uses: abatilo/[email protected]
-        with:
-          poetry-version: ${{ matrix.poetry-version }}
-      - name: Install dependencies
-        run: poetry install
-      - name: Run pdoc3
-        run: poetry run pdoc3 ./src/pygenesis --html -o docs --skip-errors
-      - name: Archive pdoc3 documentation
-        uses: actions/upload-artifact@v3
-        with:
-          name: pdoc3-html-doc
-          path: docs/**/*.html

.pylintrc

@@ -107,6 +107,7 @@ disable=abstract-method,
         suppressed-message,
         sys-max-int,
         too-few-public-methods,
+        trailing-whitespace,
         unichr-builtin,
         unicode-builtin,
         unnecessary-pass,
@@ -124,12 +125,6 @@ disable=abstract-method,
 # mypackage.mymodule.MyReporterClass.
 output-format=text
 
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]". This option is deprecated
-# and it will be removed in Pylint 2.0.
-files-output=no
-
 # Tells whether to display a full report or only the messages
 reports=no
 
@@ -248,12 +243,6 @@ ignore-long-lines=(?x)(
 # else.
 single-line-if-stmt=yes
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=
-
 # Maximum number of lines in a module
 max-module-lines=99999
 

mypy.ini

@@ -4,6 +4,7 @@
 python_version = 3.9
 warn_return_any = True
 warn_unused_configs = True
+show_error_codes=True
 
 # Per-module options:
 

nb/cache.ipynb

@@ -0,0 +1,90 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "6a0fdd61",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pygenesis\n",
+    "from pygenesis import Cube, Table, init_config, clear_cache"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6c4b965e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# only run this if you haven't done so earlier\n",
+    "# init_config()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "601075cc",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "erfolgreich (Mindestens ein Parameter enthält ungültige Werte. Er wurde angepasst, um den Service starten zu können.: name)\n"
+     ]
+    }
+   ],
+   "source": [
+    "# first, let's download two data sets\n",
+    "# these will be cached under your \n",
+    "Cube(name=\"22922KJ1141\").get_data()\n",
+    "Table(name=\"21311-0001\").get_data()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "fa6c2498",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# You can now test the clear_cache function!\n",
+    "# Either with a particular name\n",
+    "clear_cache(\"21311-0001\")\n",
+    "# Or without a name to clear the whole cache at once\n",
+    "clear_cache()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "836b9b2b",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}