better modularization

- pin docker dependency
- fix errors
- fetch-tags: true
- fetch-depth in bump-update=0 actions/checkout#1471
- setup uv

Author: vishalnandagopal

.dockerignore

@@ -1,10 +1,14 @@
+assets/sample_data.json
+sgb_advisor.log
+
 tmp/
 output/
 testing.py
 test.py
 *.log
 .python-version
 pyproject.toml
+py.typed
 
 .git
 .github
@@ -13,7 +17,6 @@ Dockerfile
 .dockerignore
 uv.lock
 .pre-commit-config.yaml
-build-and-run.sh
 
 # python generated files
 __pycache__/

.github/workflows/bump-patch-version.yml

@@ -4,30 +4,67 @@ permissions:
   contents: none
 on:
   schedule:
-    - cron: "30 10 20 11/6 *" # 20th of every November and May at 10:30 UTC
+    - cron: "30 10 27 5/5 *" # 20th of every November and May at 10:30 UTC
   workflow_dispatch:
 
 jobs:
   bump-patch-version:
     name: Bump project version
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
     steps:
       - name: Checkout the repo ⬇️
         uses: actions/checkout@v4
         with:
-          fetch-depth: 1
+          fetch-depth: 0 # actions/checkout#1471
+          fetch-tags: true
+
+      - name: Setup uv ⛏️
+        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb
 
       - name: Bump patch version 🔧
         run: |
-          # If triggered by schedule, bump the patch version to not conflict with the tag version
-          # and to ensure that the version is always incremented.
+          export SGB_ADVISOR_CURRENT_RELEASE_VERSION="v`uv version --short`"
+
+          echo "> echo \${SGB_ADVISOR_CURRENT_RELEASE_VERSION}"
+          echo "${SGB_ADVISOR_CURRENT_RELEASE_VERSION}"
+
+          if [[ ${SGB_ADVISOR_CURRENT_RELEASE_VERSION} == "v" ]]; then
+            echo "Current version ('${SGB_ADVISOR_CURRENT_RELEASE_VERSION}') could not be properly determined."
+            exit 1
+          fi
+
+          echo "> git tag"
+          git tag
+          echo "> git describe --tags $(git rev-list --tags --max-count=1)"
+          git describe --tags $(git rev-list --tags --max-count=1)
+
+          if [[ ${SGB_ADVISOR_CURRENT_RELEASE_VERSION} != "`git describe --tags $(git rev-list --tags --max-count=1)`" ]]; then
+            echo "Current version ('${SGB_ADVISOR_CURRENT_RELEASE_VERSION}') has not been tagged yet. Skipping the version bump."
+            exit 0
+          fi
+
+          # Bump patch version
           uv version --bump patch
+          uv lock --upgrade
+          uv export --no-default-groups --quiet --no-emit-project --format requirements-txt --output-file requirements.txt
+
           export SGB_ADVISOR_BUMPED_RELEASE_VERSION="v`uv version --short`"
+
+          echo "> echo \${SGB_ADVISOR_BUMPED_RELEASE_VERSION}"
+          echo "${SGB_ADVISOR_BUMPED_RELEASE_VERSION}"
+
           if [[ ${SGB_ADVISOR_BUMPED_RELEASE_VERSION} == "v" ]]; then
-            echo "Exiting because the version is not set properly"
+            echo "Exiting because '${SGB_ADVISOR_BUMPED_RELEASE_VERSION}' is not a valid release version."
             exit 1
           fi
-          git tag -a -m "Bumped version to ${SGB_ADVISOR_BUMPED_RELEASE_VERSION} "${SGB_ADVISOR_BUMPED_RELEASE_VERSION}"
+
+          # Tag and push the new version
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git add . -v pyproject.toml uv.lock requirements.txt
+          git commit -m "Bump patch version to ${SGB_ADVISOR_BUMPED_RELEASE_VERSION}"
+          git push origin master
+          git tag -a -m "Bumped version to ${SGB_ADVISOR_BUMPED_RELEASE_VERSION}" "${SGB_ADVISOR_BUMPED_RELEASE_VERSION}"
           git push origin tag "${SGB_ADVISOR_BUMPED_RELEASE_VERSION}"

.github/workflows/create-docker-image.yml

@@ -13,14 +13,15 @@ jobs:
     permissions:
       contents: read
       packages: write
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     steps:
       - name: Checkout the repo ⬇️
         uses: actions/checkout@v4
         with:
           fetch-depth: 1
 
       - name: Login to GitHub Container Registry 📖
-        uses: docker/login-action@v3
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772
         with:
           registry: ghcr.io
           username: ${{ github.actor }}

.github/workflows/publish-pypi.yml

@@ -31,13 +31,13 @@ jobs:
           python-version-file: ".python-version"
 
       - name: Setup uv 🔧
-        uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca
+        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb
         with:
           enable-cache: true
 
       - name: Install dependencies ⬇️ 📦
         run: |
-          uv sync --no-default-groups --locked
+          uv sync --only-group build --frozen
 
       - name: Build package 👷‍♂️
         run: |

.pre-commit-config.yaml

@@ -9,17 +9,15 @@ repos:
       - id: check-merge-conflict
       - id: check-symlinks
   - repo: https://github.com/astral-sh/uv-pre-commit
-    # uv version.
-    rev: 0.7.3
+    rev: 0.7.5
     hooks:
       # Update the uv lockfile
       - id: uv-lock
       - id: uv-export
-        # uv export --no-group dev --quiet --no-emit-project --format requirements-txt --output-file requirements.txt
+        # uv export --no-default-groups --quiet --no-emit-project --format requirements-txt --output-file requirements.txt
         args:
           [
-            "--no-group",
-            "dev",
+            "--no-default-groups",
             "--quiet",
             "--no-emit-project",
             "--format",
@@ -28,8 +26,7 @@ repos:
             "requirements.txt",
           ]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.11.9
+    rev: v0.11.10
     hooks:
       # Run the linter.
       - id: ruff

Dockerfile

@@ -24,9 +24,9 @@ LABEL \
     org.opencontainers.image.title="SGB Advisor" \
     org.opencontainers.image.authors="Vishal Nandagopal (dev@vishalnandagopal.com)" \
     org.opencontainers.image.description="A tool to analyse Sovereign Gold Bonds and compare their yields" \
-    org.opencontainers.image.source="https://github.com/vishalnandagopal/sgb-advisor.git" \
     org.opencontainers.image.url="https://github.com/vishalnandagopal/sgb-advisor" \
+    org.opencontainers.image.source="https://github.com/vishalnandagopal/sgb-advisor.git" \
     org.opencontainers.image.documentation="https://github.com/vishalnandagopal/sgb-advisor/blob/master/README.md#running-the-app" \
-    org.opencontainers.image.licenses="MIT"
+    org.opencontainers.image.licenses="GPL-3.0-only"
 
 ENTRYPOINT ["python3", "app.py"]

README.md

@@ -8,7 +8,7 @@ This tool tries to use publically available data and ✨maths✨ to advise you o
 
 **This does not recommend anything. Calculations, data or something else can be wrong. Do your own research before investing your money anywhere.**
 
-**Demo**: Output will being sent in [this](https://t.me/sgb_advisor) public Telegram channel at 10:00 AM IST every weekday!
+~~**Demo**: Output is being sent in [this](https://t.me/sgb_advisor) public Telegram channel at ~10:00 AM IST every weekday!~~
 
 ## Tools used:
 
@@ -26,14 +26,14 @@ You can use any of the 3 methods given below
     # Highly recommend creating a venv using `python -m venv .venv` and then activating it (https://docs.python.org/3/library/venv.html#how-venvs-work) first.
     pip install sgb-advisor
     playwright install --with-deps firefox
-    # Setup env before this
+    # Setup .env in same folder
     sgb-advisor
     ```
 
 2. Docker
 
     ```sh
-    # Setup env before this
+    # Setup .env in same folder
     docker run --env-file .env ghcr.io/vishalnandagopal/sgb-advisor:latest
     ```
 
@@ -51,6 +51,7 @@ Place the required env variables in an [`.env`](.env) file.
 ```env
 # How to notify the user. Accepted values are "telegram", "email" or "both"
 SGB_MODE=telegram
+SGB_LOG_LEVEL=info
 
 # Get token from BotFather on Telegram
 SGB_TELEGRAM_BOT_TOKEN=xxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

app.py

@@ -4,7 +4,7 @@
 load_dotenv(".env")
 
 
-def main():
+def main() -> None:
     "Entry fuction for the script"
     from src.sgb_advisor import main as main
 

pyproject.toml

@@ -1,12 +1,10 @@
 [project]
 name = "sgb-advisor"
-version = "0.1.4"
+version = "0.1.7"
 description = "A tool to analyse Sovereign Gold Bonds and compare their yields."
 readme = "README.md"
-authors = [
-    {name = "Vishal Nandagopal", email="dev@vishalnandagopal.com"}
-]
-license= "GPL-3.0-only"
+authors = [{ name = "Vishal Nandagopal", email = "dev@vishalnandagopal.com" }]
+license = "GPL-3.0-only"
 requires-python = ">=3.13"
 dependencies = [
     "loguru>=0.7.3",
@@ -16,38 +14,45 @@ dependencies = [
     "boto3>=1.38.12",
     "playwright>=1.52.0",
 ]
+keywords = ["sovereign-gold-bonds", "sgb", "india-finance", "finance"]
 
-[tool.uv]
-dev-dependencies = [
+[dependency-groups]
+dev = [
     "boto3-stubs>=1.38.12",
     "icecream>=2.1.4",
     "mypy>=1.15.0",
     "pre-commit>=4.2.0",
-    "ruff>=0.11.9",
+    "ruff>=0.11.10",
+    "ty>=0.0.1a5",
     "types-requests>=2.32.0.20250328",
-    "uv>=0.7.3",
+    "uv>=0.7.5",
 ]
+build = ["hatch>=1.14.1"]
 
-[tool.ruff.format]
-docstring-code-format = true
-docstring-code-line-length = 100
-
-[dependency-groups]
-dev = [
-    "ty>=0.0.0a7",
-]
+[project.urls]
+homepage = "https://github.com/vishalnandagopal/sgb-advisor"
+source = "https://github.com/vishalnandagopal/sgb-advisor.git"
+documentation = "https://github.com/vishalnandagopal/sgb-advisor/blob/master/README.md#running-the-app"
+issues = "https://github.com/vishalnandagopal/sgb-advisor/issues"
 
 [project.scripts]
 sgb-advisor = "sgb_advisor.__main__:main"
 
+[tool.uv]
+default-groups = "all"
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = 100
+
 [build-system]
-build-backend  = 'hatchling.build'
-requires       = ['hatchling']
+build-backend = 'hatchling.build'
+requires = ['hatchling']
 
 [tool.hatch.build.targets.sdist]
 include = [
-  "src/sgb_advisor/assets/scrips.csv",
-  "src/sgb_advisor/assets/template.html",
-  "src/sgb_advisor/assets/telegram_template.html",
-  "src/sgb_advisor/**/*.py"
+    "src/sgb_advisor/assets/scrips.csv",
+    "src/sgb_advisor/assets/template.html",
+    "src/sgb_advisor/assets/telegram_template.html",
+    "src/sgb_advisor/**/*.py",
 ]

requirements.txt

@@ -1,5 +1,5 @@
 # This file was autogenerated by uv via the following command:
-#    uv export --no-group dev --no-emit-project --format requirements-txt --output-file requirements.txt
+#    uv export --no-default-groups --no-emit-project --format requirements-txt --output-file requirements.txt
 boto3==1.38.12 \
     --hash=sha256:9939b65b0bf04781f531245f110dd0ada6825f06cf9b95350efb830b9f69d214 \
     --hash=sha256:ca06315fdb20821fc1084a7b08557556eed97cb917a30ff19d8524b495383889

src/sgb_advisor/__init__.py

@@ -2,6 +2,4 @@
 A tool to analyse Sovereign Gold Bonds and compare their yields.
 """
 
-from .data import get_sgbs as get_sgbs
-from .notify import notify as notify
 from .__main__ import main as main

src/sgb_advisor/__main__.py

@@ -1,12 +1,23 @@
-from dotenv import load_dotenv
+from os import getenv
+from pathlib import Path
 
-# Need to load dotenv before importing/running any file, since they use API keys from env modules
-load_dotenv(".env")
+from dotenv import load_dotenv
 
 
 def main():
+    # Need to load dotenv before importing/running any module file, since they use API keys from env modules
+    SGB_ENV_FILE_PATH: Path = Path(
+        getenv("SGB_ENV_FILE_PATH", str(Path.cwd() / ".env"))
+    )
+    load_dotenv(SGB_ENV_FILE_PATH)
+
+    from .data import get_sgbs as get_sgbs
+    from .logg import logger as logger
+    from .notify import notify as notify
+
+    if SGB_ENV_FILE_PATH.exists():
+        logger.debug(f"Loaded environment variables from {SGB_ENV_FILE_PATH}")
     "Entry fuction for the script"
-    from sgb_advisor import get_sgbs, notify
 
     sgbs = get_sgbs()
     notify(sgbs)

src/sgb_advisor/data.py

@@ -9,7 +9,7 @@
 from playwright.sync_api import TimeoutError as PlaywrightTimeoutError
 from playwright.sync_api import sync_playwright
 
-from .logger import logger
+from .logg import logger
 from .models import SGB
 from .quick_mafs import calculate_sgb_xirr
 

src/sgb_advisor/logger.py renamed to src/sgb_advisor/logg.py

@@ -69,7 +69,7 @@ def __init__(
         """The date of maturity of the bond"""
 
         self.xirr: float = 0
-        """XIRR which will be calculated and set later"""
+        """XIRR which can be calculated and set later"""
 
     def __str__(self) -> str:
         """

src/sgb_advisor/models.py

@@ -1,6 +1,6 @@
 from os import getenv
 
-from ..logger import logger
+from ..logg import logger
 from ..models import SGB
 from .common import tmp_folder
 from .email_sender import AWS_ACCESS_KEY_ENV, send_mail

src/sgb_advisor/notify/__init__.py

@@ -11,7 +11,7 @@
 from typing import Optional
 
 from ..data import get_price_of_gold
-from ..logger import logger
+from ..logg import logger
 from ..models import SGB
 
 tmp_folder = Path(f"{gettempdir()}/sgb_advisor")

src/sgb_advisor/notify/common.py

@@ -8,7 +8,7 @@
 from botocore.exceptions import ClientError
 
 from ..data import SGB
-from ..logger import logger
+from ..logg import logger
 from .common import generate_html_from_template
 
 AWS_ACCESS_KEY_ENV: str = "SGB_AWS_ACCESS_KEY"