clean function placement, and add universal functions

torave · Apr 21, 2025 · 8caff5a · 8caff5a
1 parent 5db8517
commit 8caff5a
Show file tree

Hide file tree

Showing 14 changed files with 217 additions and 245 deletions.
diff --git a/notebooks/notebook_compare_one_day_data.ipynb b/notebooks/notebook_compare_one_day_data.ipynb
@@ -93,7 +93,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_data import fetch_data\n",
+    "from my_package.data import fetch_time_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -105,7 +105,7 @@
     "start_date, end_date = timestamps[0], timestamps[-1]\n",
     "\n",
     "# Stores the values in the variables\n",
-    "data_city_1, folder = fetch_data(start_date, end_date, city_1)"
+    "data_city_1, folder = fetch_time_data(start_date, end_date, city_1)"
    ]
   },
   {
@@ -129,7 +129,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_data import fetch_data\n",
+    "from my_package.data import fetch_time_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -141,7 +141,7 @@
     "start_date, end_date = timestamps[0], timestamps[-1]\n",
     "\n",
     "# Stores the values in the variables\n",
-    "data_city_2, folder = fetch_data(start_date, end_date, city_2)"
+    "data_city_2, folder = fetch_time_data(start_date, end_date, city_2)"
    ]
   },
   {
@@ -176,7 +176,7 @@
     "# Gets the absolute path to the src folder\n",
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
-    "from my_package.write_data import write_data\n",
+    "from my_package.data import write_data\n",
     "\n",
     "# Overwrites the folder stored inside the function\n",
     "folder = \"../data/output_sammenligning_dag\"\n",
@@ -212,7 +212,7 @@
     "\n",
     "file_path = f'../data/output_sammenligning_dag/data_{filename}.json'\n",
     "\n",
-    "from my_package.util import extract_city_df\n",
+    "from my_package.data import extract_city_df\n",
     "\n",
     "# Load the whole JSON file\n",
     "with open(file_path, 'r') as f:\n",

diff --git a/notebooks/notebook_compare_one_week_data.ipynb b/notebooks/notebook_compare_one_week_data.ipynb
@@ -86,7 +86,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_data import fetch_data\n",
+    "from my_package.data import fetch_time_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -95,7 +95,7 @@
     "city_1 = input_place()\n",
     "\n",
     "# Stores the values in the variables\n",
-    "data_city_1, folder = fetch_data(unix_start_date, unix_end_date, city_1)"
+    "data_city_1, folder = fetch_time_data(unix_start_date, unix_end_date, city_1)"
    ]
   },
   {
@@ -121,7 +121,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_data import fetch_data\n",
+    "from my_package.data import fetch_time_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -130,7 +130,7 @@
     "city_2 = input_place()\n",
     "\n",
     "# Stores the values in the variables\n",
-    "data_city_2, folder = fetch_data(unix_start_date, unix_end_date, city_2)"
+    "data_city_2, folder = fetch_time_data(unix_start_date, unix_end_date, city_2)"
    ]
   },
   {
@@ -167,7 +167,7 @@
     "# Gets the absolute path to the src folder\n",
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
-    "from my_package.write_data import write_data\n",
+    "from my_package.data import write_data\n",
     "\n",
     "# Overwrites the folder stored inside the function\n",
     "folder = \"../data/output_sammenligning_uke\"\n",
@@ -205,7 +205,7 @@
     "\n",
     "file_path = f'../data/output_sammenligning_uke/data_{filename}.json'\n",
     "\n",
-    "from my_package.util import extract_city_df\n",
+    "from my_package.data import extract_city_df\n",
     "\n",
     "# Load the whole JSON file\n",
     "with open(file_path, 'r') as f:\n",

diff --git a/notebooks/notebook_compare_statistic_data.ipynb b/notebooks/notebook_compare_statistic_data.ipynb
@@ -38,15 +38,15 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.year_data import fetch_data\n",
+    "from my_package.data import fetch_stat_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
     "\n",
     "# User input the city, for the weather\n",
     "city_1 = input_place()\n",
     "\n",
-    "data_city_1, folder = fetch_data(city_1)"
+    "data_city_1, folder = fetch_stat_data(city_1)"
    ]
   },
   {
@@ -71,15 +71,15 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.year_data import fetch_data\n",
+    "from my_package.data import fetch_stat_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
     "\n",
     "# User input the city, for the weather\n",
     "city_2 = input_place()\n",
     "\n",
-    "data_city_2, folder = fetch_data(city_2)"
+    "data_city_2, folder = fetch_stat_data(city_2)"
    ]
   },
   {
@@ -114,7 +114,7 @@
     "# Gets the absolute path to the src folder\n",
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
-    "from my_package.write_data import write_data\n",
+    "from my_package.data import write_data\n",
     "\n",
     "# Overwrites the folder stored inside the function\n",
     "folder = \"../data/output_sammenligning_statistikk\"\n",
@@ -149,7 +149,7 @@
     "\n",
     "file_path = f'../data/output_sammenligning_statistikk/data_{filename}.json'\n",
     "\n",
-    "from my_package.util import extract_city_data_stat\n",
+    "from my_package.data import extract_city_data_stat\n",
     "\n",
     "# Load the whole JSON file\n",
     "with open(file_path, 'r') as f:\n",

diff --git a/notebooks/notebook_current_data.ipynb b/notebooks/notebook_current_data.ipynb
@@ -30,7 +30,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_current_data import fetch_current_data\n",
+    "from my_package.data import fetch_current_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -64,7 +64,7 @@
     "# Gets the absolute path to the src folder\n",
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
-    "from my_package.write_data import write_data\n",
+    "from my_package.data import write_data\n",
     "\n",
     "# The user choose the filename\n",
     "filename = input(\"Write filename: \")\n",

diff --git a/notebooks/notebook_one_day_data.ipynb b/notebooks/notebook_one_day_data.ipynb
@@ -95,7 +95,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_data import fetch_data\n",
+    "from my_package.data import fetch_time_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -107,7 +107,7 @@
     "start_date, end_date = timestamps[0], timestamps[-1]\n",
     "\n",
     "# Stores the values in the variables\n",
-    "weather_data, folder = fetch_data(start_date, end_date, city_name)"
+    "weather_data, folder = fetch_time_data(start_date, end_date, city_name)"
    ]
   },
   {
@@ -131,7 +131,7 @@
     "# Gets the absolute path to the src folder\n",
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
-    "from my_package.write_data import write_data\n",
+    "from my_package.data import write_data\n",
     "\n",
     "filename = input(\"Write filename: \")\n",
     "\n",
@@ -159,7 +159,7 @@
     "# Reads from file using pandas\n",
     "weather_data = pd.read_json(f'../data/output_stedsnavn/data_{filename}.json')\n",
     "\n",
-    "from my_package.util import extract_city_df\n",
+    "from my_package.data import extract_city_df\n",
     "\n",
     "df = extract_city_df(weather_data)\n",
     "display(df)"

diff --git a/notebooks/notebook_one_week_data.ipynb b/notebooks/notebook_one_week_data.ipynb
@@ -84,7 +84,7 @@
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
     "# Now we can import the fucntion from the module\n",
-    "from my_package.fetch_data import fetch_data\n",
+    "from my_package.data import fetch_time_data\n",
     "\n",
     "# Import function to for input_place, replace æøå\n",
     "from my_package.util import input_place\n",
@@ -93,7 +93,7 @@
     "city_name = input_place()\n",
     "\n",
     "# Stores the values in the variables\n",
-    "data, folder = fetch_data(unix_start_date, unix_end_date, city_name)\n"
+    "data, folder = fetch_time_data(unix_start_date, unix_end_date, city_name)\n"
    ]
   },
   {
@@ -118,7 +118,7 @@
     "# Gets the absolute path to the src folder\n",
     "sys.path.append(os.path.abspath(\"../src\"))\n",
     "\n",
-    "from my_package.write_data import write_data\n",
+    "from my_package.data import write_data\n",
     "\n",
     "# User chose the name for the file\n",
     "filename = input(\"Write filename: \")\n",
@@ -147,7 +147,7 @@
     "# Reads from file using pandas\n",
     "weather_data = pd.read_json(f'../data/output_stedsnavn/data_{filename}.json')\n",
     "\n",
-    "from my_package.util import extract_city_df\n",
+    "from my_package.data import extract_city_df\n",
     "\n",
     "df = extract_city_df(weather_data)\n",
     "display(df)"

diff --git a/src/README.md b/src/README.md
@@ -6,11 +6,18 @@ Mye av funksjonaliteten og funksjonener er skrevet i en vanlig `.py` fil, før d
 
 Her kommer en kjapp forklaring av de ulike filene og deres funksjoner:
 - `date_to_unix.py` bruker innebygde moduler som datetime og time, for å gjøre om datoer og tider til unix timestamp, sekunder fra 1. januar 1970.
-- `fetch_current_data.py` funksjon for å hente nåværende data for ønsket sted fra API-en. Sender feilkode dersom statusen ikke har 200, altså ok.
-- `fetch_data.py` henter data for ønsket sted, fra ønsket starttid til sluttid. Sender feilkode dersom statusen ikke har 200, altså ok.
-- `get_record.py` brukt i `notebook_statistic_data.ipynb` for å finne rekord-målinger som høyeste og laveste målte temperatur.
 - `setup.py` funskjon for å hjelpe brukeren å lage en .env fil for å lagre API-key og email.
+- `data.py` inneholder flere ulike funksjoner relatert til dataen. Til for eksempel:
+  - Hente current data
+  - Hente data for ønsket periode/dag
+  - Hente statistisk data
+  - Skrive data til json fil
+  - Hente data fra json fil, og fjerne metadata
+- `util.py` inneholder ulike funksjoner som brukes flere ganger og derfor samles i en funksjon. Til for eksempel:
+  - Input funksjon, som renser for nordiske 'æøå'
+  - Konverterer grader fra kelvin til celsius
+  - Sjekker at ønskede kolonner eksisterer i datasettet
+  - Fyller "NaN" verdier med 0, i ønskede kolonner
+  - Fjerner alle uønskede kolonner med samme endelse (notebook_statistic_data.ipynb)
+  - Henter rekord målinger (notebook_statistic_data.ipynb)
 - `test_module.py` en test funksjon for å sjekke at venv og implementering til notebook funker som det skal.
-- `util.py` inneholder funksjoner for å erstatte nordiske (æøå) og å omgjøre temperaturer fra kelvin til celsius. Altså funksjoner som bare er en enkel del av noe større.
-- `write_data.py` lagrer data i json-format, med ønsket filnavn til en 'passende' mappe basert på hvor funksjonen brukes.
-- `year_data.py` henter statistisk værdata basert på historikk for ønsket sted. Sender feilkode dersom statusen ikke har 200, altså ok.