Update project (#15)

Author: hamdanal

.github/setup/action.yml

@@ -10,7 +10,7 @@ runs:
       with:
         python-version: "3.12"
         cache: pip
-        cache-dependency-path: requirements-tests.txt
+        cache-dependency-path: requirements.txt
     - name: Install dependencies
       shell: bash
-      run: pip install -r requirements-tests.txt
+      run: pip install -r requirements.txt

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: mixed-line-ending
       - id: check-case-conflict
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.3 # must match requirements-tests.txt
+    rev: v0.8.0 # must match requirements.txt
     hooks:
       - id: ruff
       - id: ruff-format

README.md

@@ -27,7 +27,7 @@ To set up a development environment:
 2. Activate the virtual environment:
    - Unix: `. .venv/bin/activate`
    - Windows: `.venv\Scripts\activate`
-3. Install the dependencies: `python -m pip install -r requirements-tests.txt`
+3. Install the dependencies: `python -m pip install -r requirements.txt`
 
 Run `python run.py --help` for more.
 

requirements-tests.txt requirements.inrequirements-tests.txt renamed to requirements.in

@@ -1,10 +1,10 @@
 # Tools
 # -----
-ruff==0.8.0  # must match .pre-commit-config.yaml
+ruff>=0.8.0
 pytest>=8.0
 rich-argparse>=1.5.2
-mypy==1.13.0
-pyright==1.1.389
+mypy>=1.13.0
+pyright>=1.1.389
 
 # Runtime dependencies
 # --------------------

requirements.txt

@@ -0,0 +1,130 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile requirements.in -o requirements.txt
+branca==0.8.0
+    # via folium
+certifi==2024.8.30
+    # via
+    #   pyogrio
+    #   pyproj
+    #   requests
+charset-normalizer==3.4.0
+    # via requests
+contourpy==1.3.1
+    # via matplotlib
+cycler==0.12.1
+    # via matplotlib
+django-types==0.19.1
+    # via -r requirements.in
+djangorestframework-types==0.9.0
+    # via -r requirements.in
+folium==0.18.0
+    # via -r requirements.in
+fonttools==4.55.0
+    # via matplotlib
+geopandas==1.0.1
+    # via -r requirements.in
+idna==3.10
+    # via requests
+iniconfig==2.0.0
+    # via pytest
+jinja2==3.1.4
+    # via
+    #   branca
+    #   folium
+kiwisolver==1.4.7
+    # via matplotlib
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==3.0.2
+    # via jinja2
+matplotlib==3.9.2
+    # via -r requirements.in
+mdurl==0.1.2
+    # via markdown-it-py
+mypy==1.13.0
+    # via -r requirements.in
+mypy-extensions==1.0.0
+    # via mypy
+networkx==3.4.2
+    # via -r requirements.in
+nodeenv==1.9.1
+    # via pyright
+numpy==2.1.3
+    # via
+    #   contourpy
+    #   folium
+    #   geopandas
+    #   matplotlib
+    #   pandas
+    #   pandas-stubs
+    #   pyogrio
+    #   shapely
+    #   types-shapely
+packaging==24.2
+    # via
+    #   geopandas
+    #   matplotlib
+    #   pyogrio
+    #   pytest
+pandas==2.2.3
+    # via geopandas
+pandas-stubs==2.2.3.241009
+    # via -r requirements.in
+pillow==11.0.0
+    # via matplotlib
+pluggy==1.5.0
+    # via pytest
+pygments==2.18.0
+    # via rich
+pyogrio==0.10.0
+    # via geopandas
+pyparsing==3.2.0
+    # via matplotlib
+pyproj==3.7.0
+    # via geopandas
+pyright==1.1.389
+    # via -r requirements.in
+pytest==8.3.3
+    # via -r requirements.in
+python-dateutil==2.9.0.post0
+    # via
+    #   matplotlib
+    #   pandas
+pytz==2024.2
+    # via pandas
+requests==2.32.3
+    # via folium
+rich==13.9.4
+    # via rich-argparse
+rich-argparse==1.6.0
+    # via -r requirements.in
+rtree==1.3.0
+    # via -r requirements.in
+ruff==0.8.0
+    # via -r requirements.in
+shapely==2.0.6
+    # via geopandas
+six==1.16.0
+    # via python-dateutil
+types-netaddr==1.3.0.20240530
+    # via -r requirements.in
+types-psycopg2==2.9.21.20241019
+    # via
+    #   -r requirements.in
+    #   django-types
+types-python-dateutil==2.9.0.20241003
+    # via -r requirements.in
+types-pytz==2024.2.0.20241003
+    # via pandas-stubs
+types-shapely==2.0.0.20241112
+    # via -r requirements.in
+typing-extensions==4.12.2
+    # via
+    #   mypy
+    #   pyright
+tzdata==2024.2
+    # via pandas
+urllib3==2.2.3
+    # via requests
+xyzservices==2024.9.0
+    # via folium

run.py

@@ -8,7 +8,7 @@
 from subprocess import list2cmdline as l2c
 
 from rich.markdown import Markdown
-from rich_argparse import RawDescriptionRichHelpFormatter
+from rich_argparse import RawTextRichHelpFormatter
 
 default_args = {
     "ruff-check": ["tests", "stubs"],
@@ -27,45 +27,39 @@
 
 Command | Default invocation |
 ------- | ------------------ |
-{_newl.join(f"`{tool}` | `{l2c((*tool.split('-'), *default))}`" for tool, default in default_args.items())}
+{_newl.join(f"{tool} | {l2c((*tool.split('-'), *default))}" for tool, default in default_args.items())}
 
-You can override the default invocation by passing extra args after the command:
-
-E.g: `python run.py mypy tests` invokes `mypy tests` instead.
-
-Run `python -m pip install -r requirements-tests.txt` to install dependencies.
+You can override the default invocation by passing extra args after the command.
 """
 
 
 def main() -> int:
     parser = argparse.ArgumentParser(
         description=Markdown(description),  # pyright: ignore[reportArgumentType]
-        formatter_class=RawDescriptionRichHelpFormatter,
+        epilog="Run [argparse.args]python -m pip install -r requirements.txt[/] to install project dependencies.",
+        formatter_class=RawTextRichHelpFormatter,
         add_help=False,
     )
     parser.add_argument(
         "tool",
         nargs="?",
         metavar="command",
         choices=default_args,
-        help="A command from (%(choices)s) to run, optionally with args. See the table above for more information.",
+        help="A command from (%(choices)s)\nto run, optionally with args.\n\nSee the table above for more information.\n\n",
     )
     parser.add_argument(
         "-h",
         "--help",
         action="store_true",
-        help="Show this help message and exit. Use `--help CMD` to print the help of a command `CMD`.",
+        help="Show this help message and exit.\nUse --help [i]CMD[/] to print the help of command [i]CMD[/].\n\n",
     )
-    parser.add_argument("--all", action="store_true", help="Run all the commands in the table above.")
+    parser.add_argument("--all", action="store_true", help="Run all commands in the table above.")
 
     args, rest = parser.parse_known_args()
-
     tool: str | None = args.tool
 
     if args.help:
-        help_text = parser.format_help()
-        help_text = help_text[0].upper() + help_text[1:]
-        print(help_text, end="", file=sys.stderr)
+        parser.print_help(file=sys.stderr)
         if tool:
             print("\n" + "━" * 80 + "\n", file=sys.stderr)
             return subprocess.call([*tool.split("-"), "--help"])
@@ -76,7 +70,14 @@ def main() -> int:
     elif tool:
         tools = [tool]
     else:
-        parser.error(f"missing command from ({', '.join(default_args)}) or `--all`")
+        parser.print_usage(file=sys.stderr)
+        formatter = parser.formatter_class(prog=parser.prog)
+        formatter.add_text(
+            f"\n[argparse.prog]{parser.prog}[/]: [red]error:[/] missing command from "
+            f"({', '.join(f'[argparse.args]{a}[/]' for a in default_args)}) "
+            f"or [argparse.args]--all[/]"
+        )
+        parser.exit(2, formatter.format_help())
 
     ret = 0
     for tool in tools: