Feat: Add version to website (#17)

* add version to site

* change build backend to hatch

* .

Author: kevinddchen

pyproject.toml

@@ -1,8 +1,15 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "wavey/__init__.py"
+
 [project]
 name = "wavey"
-version = "0.1.0"
+dynamic = ["version"]
 authors = [
-    {name = "Kevin Chen"},
+    {name = "Kevin Chen", email = "kevinddchen@ucla.edu"},
 ]
 description = "Visualizing nearshore wave forecasts for Monterey scuba diving"
 readme = "README.md"

uv.lock

@@ -0,0 +1 @@
+__version__ = "0.1.0"

wavey/__init__.py

@@ -12,6 +12,7 @@
 from jinja2 import Environment, PackageLoader, select_autoescape
 from tqdm import tqdm
 
+import wavey
 from wavey.common import DATETIME_FORMAT, FEET_PER_METER, TZ_PACIFIC, TZ_UTC, setup_logging
 from wavey.grib import NUM_DATA_POINTS, ForecastType, read_forecast_data
 from wavey.map import DEFAULT_ARROW_LENGTH, RESOLUTION, Map
@@ -85,8 +86,6 @@ def main(
     if resolution != "f":
         LOG.warning("Not drawing full resolution coastlines. Use the flag '--resolution f'")
 
-    out_dir.mkdir(parents=True, exist_ok=True)
-
     # Download data, if needed
 
     if grib_path is None:
@@ -116,9 +115,9 @@ def main(
     mon_wave_heights_ft = wave_height_ft[..., MONASTERY_LAT_IDX, MONASTERY_LON_IDX]
     assert not np.ma.is_masked(mon_wave_heights_ft), "Unexpected: Monastery data contains masked points"
 
-    # Draw Breakwater graph
+    # Plotting swell graph
 
-    LOG.info("Drawing swell graph")
+    LOG.info("Plotting swell graph")
     fig, ax = plt.subplots(figsize=(9, 3), dpi=DPI)
 
     # NOTE: need to erase timezone info for mlpd3 to plot local times correctly
@@ -136,7 +135,7 @@ def main(
     plt.tight_layout()
     fig_div = mpld3.fig_to_html(fig)
 
-    # Draw figure
+    # Draw maps
 
     fig = plt.figure(figsize=(8, 10), dpi=DPI)
     gs = fig.add_gridspec(2, 2, height_ratios=[3, 1])
@@ -195,6 +194,7 @@ def main(
     plt.tight_layout()
     plt.colorbar(map_main.img, orientation="vertical", label="(ft)", shrink=0.8)
 
+    LOG.info("Creating colormap frames")
     plot_dir = out_dir / "plots"
     plot_dir.mkdir(parents=True, exist_ok=True)
     for hour_i in tqdm(range(NUM_DATA_POINTS)):
@@ -208,22 +208,26 @@ def main(
         ax_main.set_title(f"Significant wave height (ft) and wave direction\nHour {hour_i:03} -- {pacific_time_str}")
         savefig(plot_dir / f"{hour_i}.png")
 
-    # Get current time
+    # Get current time and version
 
     now_utc = datetime.datetime.now(tz=TZ_UTC)
     now_pacific = now_utc.astimezone(tz=TZ_PACIFIC)
     now_pacific_str = now_pacific.strftime(DATETIME_FORMAT)
 
+    version = wavey.__version__
+
     # Export HTML
 
-    LOG.info(f"Saving webpage to '{out_dir}'")
+    out_html_path = out_dir / "index.html"
+    LOG.info(f"Saving webpage to '{out_html_path}'")
     env = Environment(loader=PackageLoader("wavey"), autoescape=select_autoescape())
     template_html = env.get_template("index.html.j2")
     out_html = template_html.render(
         swell_graph=fig_div,
         last_updated=now_pacific_str,
+        version=version,
     )
-    (out_dir / "index.html").write_text(out_html)
+    out_html_path.write_text(out_html)
 
 
 if __name__ == "__main__":

wavey/__main__.py

@@ -56,7 +56,7 @@
     {{ swell_graph }}
   </div>
 
-  <div><i>Last updated: {{ last_updated }}</i></div>
+  <div><i>Last updated: {{ last_updated }} [v{{ version }}]</i></div>
   <div><a href="https://github.com/kevinddchen/wavey">Github</a></div>
 
 </body>