feat: provide jupyter notebooks exemples

jupyter/notebooks/SOLID_Musing.ipynb

@@ -1,112 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "8d39ce6d",
-   "metadata": {},
-   "source": [
-    "## *Principles* ? What is the point ?"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "c10de8ce",
-   "metadata": {},
-   "source": [
-    "The SOLID principles are:\n",
-    "\n",
-    "* The **S**ingle-Responsibility Principle (*SRP*)\n",
-    "* The **O**pen-Closed Principle (*OCP*)\n",
-    "* The **L**iskov Substitution Principle (*LSP*)\n",
-    "* The **I**nterface Segregation Principle (*ISP*)\n",
-    "* The **D**ependency inversion Principle (*DIP*)\n",
-    "\n",
-    "These five principles are not a specific ordered list (do this, then that, etc) but a collection of best practices, developed through the decades. They are gathered into an acronym, as a mnemonic vehicle to be remembered, similar to others in computer science, e.g.: *DRY*: Don’t Repeat Yourself; *KISS*: Keep It Small and Simple; as pieces of accumulated wisdom. A little side note, the acronym was created years after these five principles were set together.\n",
-    "\n",
-    "\n",
-    "\n",
-    "From https://towardsdatascience.com/solid-coding-in-python-1281392a6a94"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "014fad04",
-   "metadata": {},
-   "source": [
-    "STUPID is an acronym that describes bad practices in Oriented Object Programming:\n",
-    "\n",
-    "* **S**ingleton\n",
-    "* **T**ight Coupling\n",
-    "* **U**ntestability\n",
-    "* **P**remature Optimization\n",
-    "* **I**ndescriptive Naming\n",
-    "* **D**uplication\n",
-    "\n",
-    "from https://williamdurand.fr/2013/07/30/from-stupid-to-solid-code/#:~:text=SOLID%20is%20an%20acronym%20that,Liskov%20Substitution%20Principle\n"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "30f034a5",
-   "metadata": {},
-   "source": [
-    "# Loading the package dynamically\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "98f2f3f8",
-   "metadata": {
-    "lines_to_next_cell": 2
-   },
-   "outputs": [],
-   "source": [
-    "%load_ext autoreload\n",
-    "%autoreload 1"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "14acf530",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%aimport athai.hello"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "f8be4aa9",
-   "metadata": {},
-   "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.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

jupyter/scripts/SOLID_Musing.py

@@ -1,59 +0,0 @@
-# ---
-# jupyter:
-#   jupytext:
-#     text_representation:
-#       extension: .py
-#       format_name: percent
-#       format_version: '1.3'
-#       jupytext_version: 1.14.6
-#   kernelspec:
-#     display_name: Python 3 (ipykernel)
-#     language: python
-#     name: python3
-# ---
-
-# %% [markdown]
-# ## *Principles* ? What is the point ?
-
-# %% [markdown]
-# The SOLID principles are:
-#
-# * The **S**ingle-Responsibility Principle (*SRP*)
-# * The **O**pen-Closed Principle (*OCP*)
-# * The **L**iskov Substitution Principle (*LSP*)
-# * The **I**nterface Segregation Principle (*ISP*)
-# * The **D**ependency inversion Principle (*DIP*)
-#
-# These five principles are not a specific ordered list (do this, then that, etc) but a collection of best practices, developed through the decades. They are gathered into an acronym, as a mnemonic vehicle to be remembered, similar to others in computer science, e.g.: *DRY*: Don’t Repeat Yourself; *KISS*: Keep It Small and Simple; as pieces of accumulated wisdom. A little side note, the acronym was created years after these five principles were set together.
-#
-#
-#
-# From https://towardsdatascience.com/solid-coding-in-python-1281392a6a94
-
-# %% [markdown]
-# STUPID is an acronym that describes bad practices in Oriented Object Programming:
-#
-# * **S**ingleton
-# * **T**ight Coupling
-# * **U**ntestability
-# * **P**remature Optimization
-# * **I**ndescriptive Naming
-# * **D**uplication
-#
-# from https://williamdurand.fr/2013/07/30/from-stupid-to-solid-code/#:~:text=SOLID%20is%20an%20acronym%20that,Liskov%20Substitution%20Principle
-#
-
-# %% [markdown]
-# # Loading the package dynamically
-#
-
-# %%
-# %load_ext autoreload
-# %autoreload 1
-
-
-# %%
-# %aimport athai.hello
-
-# %% [markdown]
-#

jupyter/scripts/ex_autoreload.py

@@ -0,0 +1,38 @@
+# ---
+# jupyter:
+#   jupytext:
+#     text_representation:
+#       extension: .py
+#       format_name: percent
+#       format_version: '1.3'
+#       jupytext_version: 1.14.7
+#   kernelspec:
+#     display_name: Python 3 (ipykernel)
+#     language: python
+#     name: python3
+# ---
+
+# %% [markdown]
+# # Automatic reloading example for interactive development
+#
+
+# %%
+# %load_ext autoreload
+# %autoreload 1
+
+
+# %%
+# %aimport athai.hello
+
+# %% [markdown]
+#
+
+# %%
+from athai import hello
+
+# %%
+hello.build_greetings("Jae")
+
+# %%
+
+# %%

jupyter/scripts/test_persistent_data.py

@@ -0,0 +1,42 @@
+# ---
+# jupyter:
+#   jupytext:
+#     text_representation:
+#       extension: .py
+#       format_name: percent
+#       format_version: '1.3'
+#       jupytext_version: 1.14.7
+#   kernelspec:
+#     display_name: Python 3 (ipykernel)
+#     language: python
+#     name: python3
+# ---
+
+# %%
+import os
+from pathlib import Path
+
+import numpy as np
+import pandas as pd
+
+# %%
+from athai.data_utils import cached_download_csv
+
+# %%
+DATE_COLUMN = "date/time"
+DATA_URL = (
+    "https://s3-us-west-2.amazonaws.com/"
+    "streamlit-demo-data/uber-raw-data-sep14.csv.gz"
+)
+
+DATA_PATH = Path(os.environ.get("APP_DATA"))
+
+
+# %%
+nrows=10
+data = cached_download_csv(DATA_PATH, DATA_URL, nrows=nrows)
+data
+
+# %%
+
+# %%