ImBIOS · ImBIOS · Mar 21, 2025 · Mar 21, 2025 · Mar 21, 2025 · Mar 21, 2025
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,8 @@
+[flake8]
+max-line-length = 160
+exclude = venv,assets,.git,.github,__pycache__,.cache
+per-file-ignores =
+    # imported but unused in __init__ files
+    __init__.py: F401
+    # allow long lines in test files
+    *_test.py: E501
diff --git a/.githooks/commit-msg b/.githooks/commit-msg
@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+# Path to the commit message file (provided by Git).
+COMMIT_MSG_FILE=$1
+
+# Read the commit message from the file.
+COMMIT_MSG=$(cat "$COMMIT_MSG_FILE")
+
+# More complete regex that enforces the full format
+if [[ $COMMIT_MSG =~ ^(feat|fix|docs|style|refactor|test|chore|build|ci|perf|revert)(\([a-zA-Z0-9_.-]+\))?(!)?:[[:space:]].*$ ]]; then
+  exit 0
+else
+  echo "ERROR: Commit message does not follow Conventional Commits format."
+  echo
+  echo "The commit message should be structured as follows:"
+  echo "<type>(<optional scope>): <description>"
+  echo "[optional body]"
+  echo "[optional footer(s)]"
+  echo
+  echo "Valid types are:"
+  echo "  feat:     A new feature."
+  echo "  fix:      A bug fix."
+  echo "  docs:     Documentation changes."
+  echo "  style:    Code style changes (formatting, missing semicolons, etc.)."
+  echo "  refactor: Code refactoring (neither fixes a bug nor adds a feature)."
+  echo "  test:     Adding or updating tests."
+  echo "  chore:    Routine tasks like updating dependencies or build tools."
+  echo "  build:    Changes affecting the build system or external dependencies."
+  echo "  ci:       Changes to CI configuration files or scripts."
+  echo "  perf:     Performance improvements."
+  echo "  revert:   Reverting a previous commit."
+  echo
+  echo "Examples:"
+  echo "  feat(auth): add login functionality"
+  echo "  fix(api)!: resolve timeout issue"
+  echo "  docs(readme): update installation instructions"
+  echo
+  exit 1
+fi
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -31,10 +31,10 @@ jobs:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
 
-      - name: Setup Python 3.11 🐍
+      - name: Setup Python 3.13 🐍
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: 3.13
           cache: "pipenv"
 
       - name: Install pipenv

diff --git a/.github/workflows/codestyle.yml b/.github/workflows/codestyle.yml
@@ -12,10 +12,10 @@ jobs:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
 
-      - name: Setup Python 3.11 🐍
+      - name: Setup Python 3.13 🐍
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: 3.13
           cache: "pipenv"
 
       - name: Install pipenv

diff --git a/.gitignore b/.gitignore
@@ -175,3 +175,7 @@ cython_debug/
 
 *.lcov
 assets/
+
+# Cache files
+.cache/
+*_repo_cache.json
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,3 +29,10 @@ repos:
         language: system
         pass_filenames: false
         always_run: true
+  - repo: local
+    hooks:
+      - id: semantic-commit-msg
+        name: Semantic Commit Messages
+        entry: .githooks/commit-msg
+        language: script
+        stages: [commit-msg]
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing
 
-**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
 
 ---
 

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3.11.3-alpine
+FROM python:3.13-alpine
 
 ENV PYTHONUNBUFFERED=1
 ENV PYTHONDONTWRITEBYTECODE=1
@@ -25,4 +25,4 @@ COPY sources/ ./sources/
 RUN git config --global user.name "readme-bot" && \
   git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
 
-ENTRYPOINT ["python3", "sources/main.py"]
+ENTRYPOINT ["python3", "sources/main.py"]
diff --git a/Pipfile b/Pipfile
@@ -21,11 +21,15 @@ pyyaml = "~=6.0"
 # Codestyle checking modules:
 black = "~=25.1"
 flake8 = "~=6.0"
+# Testing modules:
 pytest = "~=8.3"
 pytest-asyncio = "~=0.25"
 pytest-cov = "~=6.0"
 pytest-mock = "~=3.14"
+# Pre-commit modules:
 pre-commit = "*"
+# Setuptools modules:
+setuptools = "*"
 
 [requires]
 python_version = "3.13"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
-> Looking For Translation to different languages & Locale  [#23](https://github.com/ImBIOS/waka-readme-stats/issues/23)
+> Looking For Translation to different languages & Locale [#23](https://github.com/ImBIOS/waka-readme-stats/issues/23)
 
 # Dev Metrics in Readme with added feature flags 🎌
 
 ![Project Preview](https://user-images.githubusercontent.com/25841814/79395484-5081ae80-7fac-11ea-9e27-ac91472e31dd.png)
 
 <p align="center">
 
-  ![Project Preview](https://user-images.githubusercontent.com/15426564/88030180-8e1c4780-cb58-11ea-8a8b-b3576dd73652.png)
+![Project Preview](https://user-images.githubusercontent.com/15426564/88030180-8e1c4780-cb58-11ea-8a8b-b3576dd73652.png)
 
   <h3 align="center">📌✨Awesome Readme Stats</h3>
 </p>
 
-----
+---
 
 <p align="center">
    <img src="https://img.shields.io/badge/language-python-blue?style"/>
@@ -43,14 +43,14 @@
 
 1. You need to update the markdown file(.md) with 2 comments. You can refer [here](#update-your-readme) for updating it.
 2. You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
-    - You can refer [here](#new-to-wakatime), if you're new to WakaTime
+   - You can refer [here](#new-to-wakatime), if you're new to WakaTime
 3. You'll need a GitHub API Token with `repo` and `user` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics
    > enabling the `repo` scope seems **DANGEROUS**<br/>
    > but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.
    - You can use [this](#profile-repository) example to work it out
 4. You need to save the WakaTime API Key and the GitHub API Token in the repository secrets. You can find that in the Settings of your repository. Be sure to save those as the following.
-    - WakaTime API Key as `WAKATIME_API_KEY=<your wakatime API Key>`
-    - GitHub Personal Access Token as `GH_TOKEN=<your github access token>`
+   - WakaTime API Key as `WAKATIME_API_KEY=<your wakatime API Key>`
+   - GitHub Personal Access Token as `GH_TOKEN=<your github access token>`
 5. You can enable and disable feature flags based on requirements.
 
 This Action will run everyday at 00.00 IST
@@ -89,7 +89,7 @@ name: Waka Readme
 on:
   schedule:
     # Runs at 12am IST
-    - cron: '30 18 * * *'
+    - cron: "30 18 * * *"
   workflow_dispatch:
 jobs:
   update-readme:
@@ -104,54 +104,83 @@ jobs:
 
 - Now you can commit and wait for run automatically, but you can also trigger to run it to see the result now. Just go to the `Actions` in your repo and select your `Profile Readme Development Stats` workflow and click in `Run workflow`. Now wait for a minute or two and you will see your changes.
 
+## Performance Optimizations
+
+### Caching
+
+waka-readme-stats includes a caching mechanism that dramatically improves performance for users with many repositories. The caching system:
+
+- Stores repository data to avoid redundant API calls
+- Only updates data for repositories that have changed
+- Significantly reduces processing time and API rate limit usage
+
+The cache is automatically maintained and no additional configuration is required.
+
+### Benchmarking
+
+For developers who want to measure performance, a benchmarking utility is included:
+
+```bash
+# Basic benchmarking with your GitHub username
+python benchmark.py --username <github_username>
+
+# Run without caching to compare performance
+python benchmark.py --username <github_username> --no-cache
+
+# Run full benchmark suite (includes all API calls)
+python benchmark.py --username <github_username> --full
+```
+
+The benchmarking tool provides detailed metrics on execution time, helping to identify performance bottlenecks.
+
 ## Extras
 
 1. If you want to add the other info to your stats, you can add multiple `FLAGS` in your workflow file by default all flags are enabled
 
->except the lines of code flag due to heavy operation performed
+> except the lines of code flag due to heavy operation performed
 
 ```yml
 - uses: ImBIOS/waka-readme-stats@master
   with:
-      WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
-      GH_TOKEN: ${{ secrets.GH_TOKEN }}
-      SHOW_OS: "False"
-      SHOW_PROJECTS: "False"
+    WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
+    GH_TOKEN: ${{ secrets.GH_TOKEN }}
+    SHOW_OS: "False"
+    SHOW_PROJECTS: "False"
 ```
 
 ### Flags Available
 
 ---
 
-`LOCALE`  This Flag can be used to show stats in your language default is english uses Locale [Short Hand](https://saimana.com/list-of-country-locale-code/) to be passed in the flag variable example of the final result can be found [here](https://github.com/ImBIOS/ImBIOS/blob/master/Readme-fr.md)
+`LOCALE` This Flag can be used to show stats in your language default is english uses Locale [Short Hand](https://saimana.com/list-of-country-locale-code/) to be passed in the flag variable example of the final result can be found [here](https://github.com/ImBIOS/ImBIOS/blob/master/Readme-fr.md)
 
-`SECTION_NAME`        flag can be set to any string, and will be the name of the section to replace in the readme
+`SECTION_NAME` flag can be set to any string, and will be the name of the section to replace in the readme
 
-`COMMIT_BY_ME`        flag can be set to `True` to commit the code using your name and email
+`COMMIT_BY_ME` flag can be set to `True` to commit the code using your name and email
 
-`COMMIT_MESSAGE`        flag can be set to message commit, default is "Updated with Dev Metrics"
+`COMMIT_MESSAGE` flag can be set to message commit, default is "Updated with Dev Metrics"
 
-`COMMIT_USERNAME`        flag can be set to username to commit the code, default is "readme-bot"
+`COMMIT_USERNAME` flag can be set to username to commit the code, default is "readme-bot"
 
-`COMMIT_EMAIL`        flag can be set to email to commit the code, default is "41898282+github-actions[bot]@users.noreply.github.com"
+`COMMIT_EMAIL` flag can be set to email to commit the code, default is "41898282+github-actions[bot]@users.noreply.github.com"
 
-`SHOW_UPDATED_DATE`        flag can be set to `True` to show updated date in end of paragraph
+`SHOW_UPDATED_DATE` flag can be set to `True` to show updated date in end of paragraph
 
-`UPDATED_DATE_FORMAT`        flag can be set to put updated date into a format, default is `"%d/%m/%Y %H:%M:%S"`
+`UPDATED_DATE_FORMAT` flag can be set to put updated date into a format, default is `"%d/%m/%Y %H:%M:%S"`
 
-`SHOW_LINES_OF_CODE`       flag can be set to `True` to show the Lines of code writen till date
+`SHOW_LINES_OF_CODE` flag can be set to `True` to show the Lines of code writen till date
 
 ![Lines of code](https://img.shields.io/badge/From%20Hello%20World%20I've%20written-1.3%20million%20Lines%20of%20code-blue)
 
-`SHOW_TOTAL_CODE_TIME`       flag can be set to `False` to hide *Code Time*
+`SHOW_TOTAL_CODE_TIME` flag can be set to `False` to hide _Code Time_
 
 ![Code Time](http://img.shields.io/badge/Code%20Time-1%2C438%20hrs%2054%20mins-blue)
 
-`SHOW_PROFILE_VIEWS`       flag can be set to `False` to hide the Profile views
+`SHOW_PROFILE_VIEWS` flag can be set to `False` to hide the Profile views
 
 ![Profile Views](http://img.shields.io/badge/Profile%20Views-2189-blue)
 
-`SHOW_COMMIT`       flag can be set to `False` to hide the commit stats
+`SHOW_COMMIT` flag can be set to `False` to hide the commit stats
 
 **I'm an early 🐤**
 
@@ -163,7 +192,7 @@ jobs:
 
 ```
 
-`SHOW_DAYS_OF_WEEK`       flag can be set to `False` to hide the commits made on different days of week
+`SHOW_DAYS_OF_WEEK` flag can be set to `False` to hide the commits made on different days of week
 
 📅 **I'm Most Productive on Sundays**
 
@@ -178,7 +207,7 @@ Sunday       86 commits     █████░░░░░░░░░░░░
 
 ```
 
-`SHOW_LANGUAGE`       flag can be set to `False` to hide the Coding Language You use
+`SHOW_LANGUAGE` flag can be set to `False` to hide the Coding Language You use
 
 ```text
 💬 Languages:
@@ -189,7 +218,7 @@ Python                   22 mins             █░░░░░░░░░░
 XML                      8 mins              ░░░░░░░░░░░░░░░░░░░░░░░░░   1.62%
 ```
 
-`SHOW_OS`       flag can be set to `False` to hide the OS details
+`SHOW_OS` flag can be set to `False` to hide the OS details
 
 ```text
 💻 Operating Systems:
@@ -213,7 +242,7 @@ denAPI                   40 mins             ██░░░░░░░░░
 ⌚︎ Timezone: Asia/Calcutta
 ```
 
-`SHOW_EDITORS`  flag can be set to `False` to hide the list of code-editors used
+`SHOW_EDITORS` flag can be set to `False` to hide the list of code-editors used
 
 ```text
 🔥 Editors:
@@ -222,7 +251,7 @@ PhpStorm                 1 hr 35 mins        ████░░░░░░░
 PyCharm                  23 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.49%
 ```
 
-`SHOW_LANGUAGE_PER_REPO`  flag can be set to `False` to hide the Number of repository in different language and frameworks
+`SHOW_LANGUAGE_PER_REPO` flag can be set to `False` to hide the Number of repository in different language and frameworks
 
 **I mostly code in Vue**
 
@@ -237,32 +266,33 @@ CSS          2 repos        █░░░░░░░░░░░░░░░░
 
 ```
 
-`SHOW_SHORT_INFO`  flag can be set to `False` to hide the short fun fact info of user
->This section requires personal access token with user permission otherwise data shown will be incorrect here
+`SHOW_SHORT_INFO` flag can be set to `False` to hide the short fun fact info of user
+
+> This section requires personal access token with user permission otherwise data shown will be incorrect here
 
 **🐱 My GitHub Data**
 
 > 🏆 433 Contributions in year 2020
- >
+>
 > 📦 Used 292.3 kB in GitHub's Storage
- >
+>
 > 💼 Opted to Hire
- >
+>
 > 📜 25 Public Repository
- >
+>
 > 🔑 15 Owned Private Repository
 
-`SHOW_LOC_CHART`  flag can be set to `False` to hide the Lines of code written in different quarters of different year
+`SHOW_LOC_CHART` flag can be set to `False` to hide the Lines of code written in different quarters of different year
 
-`IGNORED_REPOS`  flag can be set to `"waka-readme-stats, my-first-repo"` (just an example) to ignore some repos you don’t want to be counted
+`IGNORED_REPOS` flag can be set to `"waka-readme-stats, my-first-repo"` (just an example) to ignore some repos you don't want to be counted
 
 `SYMBOL_VERSION` flag can be set symbol for progress bar (default: `1`)
 
 | Version | Done block | Empty block |
-|-------- | ---------- | ----------- |
-|    1    |      █     |       ░     |
-|    2    |      ⣿     |       ⣀     |
-|    3    |      ⬛    |       ⬜    |
+| ------- | ---------- | ----------- |
+| 1       | █          | ░           |
+| 2       | ⣿          | ⣀           |
+| 3       | ⬛         | ⬜          |
 
 `DEBUG_LOGGING` flag can be set to increase action output verbosity, by default equals internal runner debug property
 
@@ -436,8 +466,7 @@ Made with :heart: and Python 🐍.
 
 # Inspired From
 
-> [Awesome Pinned Gists](https://github.com/matchai/awesome-pinned-gists) <br/>
-> [athul/waka-readme](https://github.com/athul/waka-readme)
+> [Awesome Pinned Gists](https://github.com/matchai/awesome-pinned-gists) <br/> > [athul/waka-readme](https://github.com/athul/waka-readme)
 
 ### This project need a **star** ⭐ from you ♥
-Original file line number
+Diff line change
@@ Expand Up / @@ -175,3 +175,7 @@ cython_debug/ @@
     *.lcov
     assets/
+    # Cache files
+    .cache/
+    *_repo_cache.json