Merge pull request #25 from JosephBARBIERDARNAL/updates

add linter in ci

Author: JosephBARBIERDARNAL

.github/workflows/lint.yaml

@@ -0,0 +1,28 @@
+name: Check Code Formatting
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check-formatting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+
+      - name: Install Ruff
+        run: pip install ruff==0.9.10
+
+      - name: Run Ruff format check
+        run: ruff format --check .
+
+      - name: Run Ruff linting and auto-fix
+        run: ruff check --fix .

.github/workflows/site.yaml

@@ -1,11 +1,14 @@
-name: ci 
+name: ci
+
 on:
   push:
-    branches:
-      - master 
-      - main
+    branches: [main]
+  pull_request:
+    branches: [main]
+
 permissions:
   contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -18,12 +21,12 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
       - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material 
-      - run: mkdocs gh-deploy --force
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

dayplot/main.py

@@ -22,6 +22,7 @@ def calendar(
     edgecolor: str = "black",
     edgewidth: float = 0.0,
     cmap: Union[str, LinearSegmentedColormap] = "Greens",
+    week_starts_on: str = "Sunday",
     month_kws: Optional[Dict] = None,
     day_kws: Optional[Dict] = None,
     day_x_margin: float = 0.02,
@@ -31,7 +32,6 @@ def calendar(
     vcenter: Optional[float] = None,
     boxstyle: Union[str, matplotlib.patches.BoxStyle] = "square",
     ax: Optional[matplotlib.axes.Axes] = None,
-    week_starts_on: str = "Sunday",
     **kwargs,
 ) -> List[matplotlib.patches.Rectangle]:
     """
@@ -50,6 +50,7 @@ def calendar(
 
     Parameters
     ----------
+
     dates
         A list of date-like objects (e.g., datetime.date, datetime.datetime, or
         strings in "YYYY-MM-DD" format). Must have the same length as values.
@@ -77,6 +78,9 @@ def calendar(
         A valid Matplotlib colormap name or a LinearSegmentedColormap instance.
         Defaults to "Greens". The colormap is used to determine the fill color
         intensity of each day's cell based on its value.
+    week_starts_on
+        The starting day of the week, which can be specified as a string ("Sunday", "Monday",
+        ..., "Saturday"). Defaults to "Sunday".
     month_kws
         Additional keyword arguments passed to the matplotlib.axes.Axes.text function when
         labeling month names (outside of x, y and s).
@@ -111,25 +115,25 @@ def calendar(
         A matplotlib axes. If None, plt.gca() will be used. It is advisable to make
         this explicit to avoid unexpected behaviour, particularly when manipulating a
         figure with several axes.
-    week_starts_on
-        The starting day of the week, which can be specified as a string ("Sunday", "Monday",
-        ..., "Saturday"). Defaults to "Sunday".
     kwargs
         Any additional arguments that will be passed to matplotlib.patches.FancyBboxPatch. For example,
         you can set `alpha`, `hatch`, `linestyle`, etc.
         You can find them all here: https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.FancyBboxPatch.html
 
     Returns
     -------
+
     A list of matplotlib.patches.FancyBboxPatch (one for each cell).
 
     Notes
     -----
+
     - The function aggregates multiple entries for the same date by summing their
       values.
 
     Examples
     --------
+
     >>> import dayplot as dp
     >>> import pandas as pd
     >>> df = pd.DataFrame({
@@ -343,21 +347,3 @@ def calendar(
         ax.text(-day_x_margin, y_tick, day_label, **day_text_style)
 
     return rect_patches
-
-
-if __name__ == "__main__":
-    import numpy as np
-    import dayplot as dp
-
-    df = dp.load_dataset()
-
-    fig, ax = plt.subplots(figsize=(15, 6))
-    calendar(
-        df["dates"],
-        df["values"],
-        start_date="2024-01-01",
-        end_date="2024-12-31",
-        week_starts_on="Sunday",
-    )
-    fig.savefig("test.png", dpi=300, bbox_inches="tight")
-    plt.close()

docs/gallery.md

@@ -85,5 +85,9 @@
 [![advanced-2](img/advanced/advanced-2.png)](tuto/advanced.md)
 
 
+<br>
+[![advanced-3](img/advanced/advanced-3.png)](tuto/advanced.md)
+
+
 <br>