Add application version to dashboard homepage #388

SaitejaKommi · 2026-01-08T15:46:13Z

Pull Request

Description

The version is retrieved dynamically using importlib.metadata via a small helper (get_version) and displayed on the home page for both:

UK Analysis Dashboard
India Analysis Dashboard

This avoids hard-coding version strings and ensures the displayed version matches the installed package version in deployed environments.

Fixes #385

How Has This Been Tested?

Ran the application locally using:

uv run streamlit run src/main.py

Verified that the dashboard renders correctly and the version string is displayed on the homepage.
Confirmed expected fallback behaviour (v?) when the package is not installed locally.
Yes

If your changes affect data processing, have you plotted any changes?

Not applicable (UI-only change)

Checklist:

My code follows OCF's coding style guidelines
I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
I have checked my code and corrected any misspellings

peterdudfield · 2026-01-08T17:14:53Z

Have you tried this when running docker?

SaitejaKommi · 2026-01-09T04:56:45Z

Thanks for checking, @peterdudfield .
I haven’t tested this in Docker yet — I’ve only verified it locally via uv run streamlit run src/main.py.
I’ll run the Docker build and confirm whether the version renders correctly there, and update the PR shortly.

SaitejaKommi · 2026-01-09T05:30:59Z

Hi @peterdudfield — yes, I’ve now tested this using Docker.

I built the image locally and ran the container, and the version renders correctly on the homepage (v0.1.0) when the package is installed, with the expected fallback when it isn’t.

Happy to adjust if you’d prefer the version placement or formatting to change.

peterdudfield · 2026-01-09T08:11:21Z

The latest git version is v1.0.7. It would be good to show that

peterdudfield · 2026-01-09T08:12:05Z

You might need to do some changes that are in https://github.com/openclimatefix/analysis-dashboard/pull/385/files

SaitejaKommi · 2026-01-10T16:42:17Z

Hi @peterdudfield — quick check:
when testing the Docker build locally, the initial build takes ~20–25 minutes due to the torch + scientific Python dependencies (CPU-only torch).
The build completes successfully and the app runs with the correct version shown (1.0.7).
Just wanted to confirm this build time is expected/acceptable and that there’s nothing else you’d like me to optimise at this stage.

SaitejaKommi · 2026-01-10T17:02:56Z

Hi @peterdudfield — thanks for your patience.
I’ve pushed the latest changes and verified everything end-to-end:

Version resolves from git tags (1.0.7)

Docker builds and runs successfully

After login, the Home page displays v1.0.7

All changes are limited to packaging/versioning and Docker reproducibility.
Please let me know if you’d like any adjustments.

peterdudfield · 2026-01-16T16:30:18Z

Dockerfile

-COPY pyproject.toml ./
-COPY README.md ./
+# Copy full repository INCLUDING .git
+COPY . .


could you just copy over the files you need please. This helps keep it a bit trimmer

Hi @peterdudfield , I’ve pushed an update that resolves the dashboard version directly from the installed package using importlib.metadata.version("analysis-dashboard"), and simplified the Docker build to only copy the files needed.

This removes the need for a separate directory just for versioning and shows the latest git-tagged version (v1.0.7).
Happy to adjust if you’d prefer a different pattern.

peterdudfield · 2026-01-16T16:32:33Z

Is there any way to do this, where you dont have to create a sepearate dir for analys-dasboad just for versions

…rsioning

SaitejaKommi · 2026-01-18T07:16:14Z

Is there any way to do this, where you dont have to create a sepearate dir for analys-dasboad just for versions

Hi @peterdudfield I pushed a follow-up commit that removes the package-based version approach and instead reads the version directly from importlib.metadata.
This avoids having a separate directory just for versioning and keeps git tags as the single source of truth.
The dashboard now shows v1.0.7 locally and in Docker.

Please let me know if you’d like any adjustments.

peterdudfield · 2026-01-19T09:14:49Z

src/main.py

+    st.text(
+        "This is the Analysis Dashboard UK. "
+        "Please select the page you want from the menu at the top of this page"
+    )


Could you remove this from the metric page? I dont think this is needed

peterdudfield · 2026-01-19T09:15:00Z

src/main.py

 from batch_page import batch_page

-st.get_option("theme.primaryColor")
-st.set_page_config(layout="wide", page_title="OCF Dashboard")


can you role this change back?

can you remove the comment in the code

peterdudfield · 2026-01-19T09:15:51Z

pyproject.toml

    "fiona>=1.9,<2.0",
    "herbie-data",
    "numcodecs>=0.12,<1.0",
-    "torch @ https://download.pytorch.org/whl/cpu/torch-2.3.1%2Bcpu-cp312-cp312-linux_x86_64.whl ; platform_system == 'Linux' and platform_machine == 'x86_64'",


can you role this change back please?

please remove comment, thats not needed

remove # comment, its not needed

peterdudfield · 2026-01-19T09:16:13Z

pyproject.toml

-    "pytest",
-    "pytest-cov",
-    "ruff",
-]


why has this been removed?

I was restructuring the packaging while debugging the versioning issue and accidentally removed the [tool.uv].dev-dependencies block while consolidating configuration. There was no intention to drop the dev tooling. I’ve restored the following so local development and CI continue to work as before:

why have you not put it back in then?

peterdudfield

Thanks for this, I think there are few chagnes that are unnecessary, could you role thsoe back please?

SaitejaKommi · 2026-01-19T10:59:43Z

Thanks for this, I think there are few chagnes that are unnecessary, could you role thsoe back please?

Thanks @peterdudfield , I’ve rolled back the unnecessary dependency and config changes, restored the original torch handling and dev dependencies, and kept the version display minimal without introducing a separate package. Please let me know if this looks better now.
Sorry about the unnecessary changes earlier,
I had initially missed that this text belonged to the metrics page and added it in the wrong place.
I’ve now reverted those changes and only updated main.py to display the package version on the home page.

peterdudfield · 2026-01-19T11:04:15Z

Dockerfile

+# Remove git metadata after install (keeps image small)
+RUN rm -rf .git

-EXPOSE 5433


why have you removed exposing port 5433?

peterdudfield · 2026-01-19T11:04:30Z

docker-compose.yml

-      - "8501:8501" # Mapping the Streamlit port
-      - "5433:5433" # Database port (if necessary)
+      - "8501:8501"
+      - "5433:5433"


can you role these changes back please?

peterdudfield · 2026-01-19T11:04:42Z

docker-compose.yml

+      DB_URL: ${DB_URL:-}
+      PASSWORD: ${PASSWORD:-example}
+      AUTH0_CLIENT_ID: ${AUTH0_CLIENT_ID:-}
+      AUTH0_DOMAIN: ${AUTH0_DOMAIN:-}


why have you changes this?

Sincere apologies for the noise on this PR.

I realise I made several changes that went beyond the original scope, which caused unnecessary confusion and extra review effort. That wasn’t my intention, and I’m sorry for the back-and-forth it created.

I’ve now taken a step back, reviewed the original code carefully, and understand where I went wrong. Before pushing the next update, I wanted to acknowledge this and thank you for your patience and clear feedback.

I’ll keep the upcoming changes minimal, scoped, and aligned with upstream expectations.

SaitejaKommi · 2026-01-19T12:02:22Z

Thanks a lot @peterdudfield 🙏 for your patience here, and sorry for the noise in the earlier updates.

I realised I’d bundled a few unrelated changes together while iterating locally (Docker, compose comments, and some config tweaks), which wasn’t ideal. I’ve now rolled those back so this PR is focused only on the intended change:

Displaying the package version on the dashboard home page using importlib.metadata, without adding a separate version module or package.

Removing the extra text from the metrics page as suggested.

Restoring the original Dockerfile and docker-compose behaviour (ports, env vars, and comments) to match upstream.

I’ve also cleaned up the commit history to avoid duplicate commit messages.

Thanks again for the review and guidance — let me know if you’d like anything adjusted further

Add application version to dashboard homepage

57871b5

Expose git-based version in dashboard and fix packaging

dc505fe

Fix dockerignore and git tag fetching

a8654ec

peterdudfield reviewed Jan 16, 2026

View reviewed changes

SaitejaKommi added 3 commits January 17, 2026 06:16

Show installed package version on dashboard homepage

2793e67

Display package version from git metadata in UI

5e41273

Fix version display using importlib.metadata; remove package-based ve…

7453e46

…rsioning

peterdudfield reviewed Jan 19, 2026

View reviewed changes

peterdudfield requested changes Jan 19, 2026

View reviewed changes

SaitejaKommi added 2 commits January 19, 2026 16:15

Roll back unnecessary changes and keep minimal git-based versioning

fe49b74

Update main.py

7c73083

peterdudfield reviewed Jan 19, 2026

View reviewed changes

SaitejaKommi added 2 commits January 19, 2026 17:18

Display package version on dashboard home page

f9f10e1

Tidy version display and revert unrelated changes

6e41315

SaitejaKommi requested a review from peterdudfield January 19, 2026 16:04

Uh oh!

Add application version to dashboard homepage #388

Are you sure you want to change the base?

Add application version to dashboard homepage #388

Uh oh!

Conversation

SaitejaKommi commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Description

How Has This Been Tested?

Checklist:

Uh oh!

peterdudfield commented Jan 8, 2026

Uh oh!

SaitejaKommi commented Jan 9, 2026

Uh oh!

SaitejaKommi commented Jan 9, 2026

Uh oh!

peterdudfield commented Jan 9, 2026

Uh oh!

peterdudfield commented Jan 9, 2026

Uh oh!

SaitejaKommi commented Jan 10, 2026

Uh oh!

SaitejaKommi commented Jan 10, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peterdudfield commented Jan 16, 2026

Uh oh!

SaitejaKommi commented Jan 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peterdudfield Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peterdudfield Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peterdudfield left a comment

Choose a reason for hiding this comment

Uh oh!

SaitejaKommi commented Jan 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SaitejaKommi commented Jan 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SaitejaKommi commented Jan 8, 2026 •

edited

Loading

peterdudfield Jan 19, 2026 •

edited

Loading

peterdudfield Jan 19, 2026 •

edited

Loading