precommit

Author: nabobalis

.github/dependabot.yml

@@ -4,3 +4,5 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    exclude-paths:
+      - "tests/assets/test_data"

.github/workflows/test_action.yaml

@@ -10,7 +10,7 @@ jobs:
         uses: actions/checkout@v6
       - name: Generate version data using local action
         uses: ./
-        with: 
+        with:
           project_file_name: tests/test_data/pyproject.toml
           create_pr: false
-          schedule_path: tests/test_data/test_schedule.json
+          schedule_path: tests/test_data/test_schedule.json

.pre-commit-config.yaml

@@ -14,21 +14,18 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-
   - repo: https://github.com/rbubley/mirrors-prettier
     rev: 787fb9f542b140ba0b2aced38e6a3e68021647a3 # frozen: v3.5.3
     hooks:
       - id: prettier
         files: \.(css|html|md|yml|yaml|gql)
         args: [--prose-wrap=preserve]
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: 971923581912ef60a6b70dbf0c3e9a39563c9d47 # frozen: v0.11.4
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes", "--exit-non-zero-on-fix"]
       - id: ruff-format
-
   - repo: https://github.com/codespell-project/codespell
     rev: "63c8f8312b7559622c0d82815639671ae42132ac" # frozen: v2.4.1
     hooks:

action.yaml

@@ -6,19 +6,19 @@ inputs:
     description: "Target branch for the pull request"
     required: true
     default: "main"
-  project_file_name: 
+  project_file_name:
     description: "Path to the project file listing dependencies, relative to repository root. Defaults to 'pyproject.toml'. Currently only pyproject.toml is supported."
     required: true
     default: "pyproject.toml"
-  create_pr: 
+  create_pr:
     description: "Whether the action should open a PR or not. Set to false for dry-run/testing."
     required: true
     default: true
-  commit_msg: 
+  commit_msg:
     description: "Commit message for the commit to update the versions. by default 'Drop support for unsupported packages conform SPEC 0'. has no effect if `create_pr` is set to false"
     required: false
     default: "chore: Drop support for unsupported packages conform SPEC 0"
-  pr_title: 
+  pr_title:
     description: "The title of the PR that will be opened. by default 'Drop support for unsupported packages conform SPEC 0'. has no effect if `create_pr` is set to false"
     required: false
     default: "chore: Drop support for unsupported packages conform SPEC 0"
@@ -66,7 +66,6 @@ runs:
           echo "Schedule file already exists at $SCHEDULE_FILE"
         fi
 
-
     - name: Run update script
       shell: bash
       run: |
@@ -94,5 +93,5 @@ runs:
         branch: update-spec0-dependencies-${{ github.run_id }}
 
 branding:
-  icon: 'check-square'
-  color: 'blue'
+  icon: "check-square"
+  color: "blue"

pyproject.toml

@@ -30,4 +30,3 @@ pytest = "*"
 
 [tool.pixi.environments]
 test = ["test"]
-

readme.md

@@ -1,25 +1,27 @@
 # SPEC 0 Versions Action
 
-This repository contains a Github Action to update Python dependencies in your `pyproject.toml` such that they conform to the SPEC 0 support schedule. You can find this schedule [here](https://scientific-python.org/specs/spec-0000/)
+This repository contains a Github Action to update Python dependencies in your `pyproject.toml` such that they conform to the SPEC 0 support schedule.
+[You can find this schedule here.](https://scientific-python.org/specs/spec-0000/)
 
 ## Using the action
 
-
 ### Example workflow
 
-To use the action you can copy the yaml below, and paste it into `.github/workflows/update-spec0.yaml`. Whenever the action is triggered it will open a PR in your repository that will update the dependencies of SPEC 0 to the new lower bound. For this you will have to provide it with a PAT that has write permissions in the `contents` and `pull request` scopes. Please refer to the GitHub documentation for instructions on how to do this [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
-
+To use the action you can copy the yaml below, and paste it into `.github/workflows/update-spec0.yaml`.
+Whenever the action is triggered it will open a PR in your repository that will update the dependencies of SPEC 0 to the new lower bound.
+For this you will have to provide it with a PAT that has write permissions in the `contents` and `pull request` scopes.
+[Please refer to the GitHub documentation for instructions on how to do this here.](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
 
 ```yaml
 name: Update SPEC 0 dependencies
 
 on:
   schedule:
     # At 00:00 on day-of-month 3 in every 3rd month. (i.e. every quarter)
-    # Releases should happen on the second day of the quarter in savente93/SPEC0-schedule to 
+    # Releases should happen on the second day of the quarter in savente93/SPEC0-schedule to
     # avoid fence post errors, so allow one day as a buffer to avoid timing issues here as well.
     - cron: "0 0 3 */3 *"
-  # On demand: 
+  # On demand:
   workflow_dispatch:
 
 permissions:
@@ -30,33 +32,32 @@ jobs:
   update:
     runs-on: ubuntu-latest
     steps:
-      - uses: savente93/update-spec0-dependencies@v1.0.0
+      - uses: scientific-python/spec0-action@v1.0.0
         with:
           token: ${{ secrets.GH_PAT }} # <- GH_PAT you will have to configure in the repo as a secret
 ```
 
-It should update any of the packages listed in the `dependency`, or `tool.pixi.*` tables. For examples of before and after you can see [./tests/test_data/pyproject.toml](./tests/test_data/pyproject.toml) and [./tests/test_data/pyproject_updated.toml](./tests/test_data/pyproject_updated.toml) respectively. Other tools are not yet supported, but I am open to feature requests.
-
-The newest lower bounds will be downloaded from [https://github.com/savente93/SPEC0-schedule](https://github.com/savente93/SPEC0-schedule) but you should not have to worry about this. 
+It should update any of the packages listed in the `dependency`, or `tool.pixi.*` tables.
+For examples of before and after you can see [./tests/test_data/pyproject.toml](./tests/test_data/pyproject.toml) and [./tests/test_data/pyproject_updated.toml](./tests/test_data/pyproject_updated.toml) respectively.
+Other tools are not yet supported, but we are open to feature requests.
 
+The newest lower bounds will be downloaded from [https://github.com/savente93/SPEC0-schedule](https://github.com/savente93/SPEC0-schedule) but you should not have to worry about this.
 
 ### Parameters
 
-| Input               | Required | Default            | Description                                                                    |
-| ------------------- | -------- | ------------------ | -------------------------------------------------------------------------------|
-| token               | yes      | —                  | Personal access token with `contents` & `pull-request` scopes                  |
-| project\_file\_name | no       | `"pyproject.toml"` | File to update dependencies in                                                 |
-| schedule\_path      | no       | `"schedule.json"`  | path to schedule json data. only relevant if you have it committed in your repo |
-| target\_branch      | no       | `"main"`           | Branch to open PR against                                                      |
-| create_pr           | no       | `true`             | Open a PR with new versions                                                    |
-| pr_title            | no       | `chore: Drop support for unsupported packages conform SPEC 0`             | The title of the PR that will be opened                                                    |
-| commit_msg            | no       | `chore: Drop support for unsupported packages conform SPEC 0`             | Commit message of the commit to update the versions.                                                     |
-
+| Input             | Required | Default                                                       | Description                                                                     |
+| ----------------- | -------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| token             | yes      | —                                                             | Personal access token with `contents` & `pull-request` scopes                   |
+| project_file_name | no       | `"pyproject.toml"`                                            | File to update dependencies in                                                  |
+| schedule_path     | no       | `"schedule.json"`                                             | path to schedule json data. only relevant if you have it committed in your repo |
+| target_branch     | no       | `"main"`                                                      | Branch to open PR against                                                       |
+| create_pr         | no       | `true`                                                        | Open a PR with new versions                                                     |
+| pr_title          | no       | `chore: Drop support for unsupported packages conform SPEC 0` | The title of the PR that will be opened                                         |
+| commit_msg        | no       | `chore: Drop support for unsupported packages conform SPEC 0` | Commit message of the commit to update the versions.                            |
 
 ## Limitations
 
 1. Since this action simply parses the toml to do the upgrade and leaves any other bounds intact, it is possible that the environment of the PR becomes unsolvable.
-   For example if you have a numpy dependency like so: `numpy = ">=1.25.0,<2"` this will get updated in the PR to `numpy = ">=2.0.0,<2"` which is infeasible. 
+   For example if you have a numpy dependency like so: `numpy = ">=1.25.0,<2"` this will get updated in the PR to `numpy = ">=2.0.0,<2"` which is infeasible.
    Keeping the resulting environment solvable is outside the scope of this action, so you might have to adjust them manually.
-2. Currently only `pyproject.toml` is supported by this action, though other manifest files could be considered upon request. 
-
+2. Currently only `pyproject.toml` is supported by this action, though other manifest files could be considered upon request.

run_spec0_update.py

@@ -3,24 +3,36 @@
 from argparse import ArgumentParser
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     parser = ArgumentParser(
-                        description='A script to update your project dependencies to be in line with the scientific python SPEC 0 support schedule',
-                        )
-
-    parser.add_argument('toml_path', default="pyproject.toml", help="Path to the project file that lists the dependencies. defaults to 'pyproject.toml'.")           
-    parser.add_argument('schedule_path', default="schedule.json", help="Path to the schedule json payload. defaults to 'schedule.json'")           
+        description="A script to update your project dependencies to be in line with the scientific python SPEC 0 support schedule",
+    )
+
+    parser.add_argument(
+        "toml_path",
+        default="pyproject.toml",
+        help="Path to the project file that lists the dependencies. defaults to 'pyproject.toml'.",
+    )
+    parser.add_argument(
+        "schedule_path",
+        default="schedule.json",
+        help="Path to the schedule json payload. defaults to 'schedule.json'",
+    )
 
     args = parser.parse_args()
 
     toml_path = Path(args.toml_path)
     schedule_path = Path(args.schedule_path)
 
     if not toml_path.exists():
-        raise ValueError(f"{toml_path} was supplied as path to project file but it did not exist")
+        raise ValueError(
+            f"{toml_path} was supplied as path to project file but it did not exist"
+        )
 
     if not schedule_path.exists():
-        raise ValueError(f"{schedule_path} was supplied as path to schedule file but it did not exist")
+        raise ValueError(
+            f"{schedule_path} was supplied as path to schedule file but it did not exist"
+        )
 
     project_data = read_toml(toml_path)
     schedule_data = read_schedule(schedule_path)

spec0_action/__init__.py

@@ -11,13 +11,14 @@
     parse_version_spec,
     read_schedule,
     read_toml,
-    write_toml
+    write_toml,
 )
 from packaging.version import Version
 
 
 __all__ = ["read_schedule", "read_toml", "write_toml", "update_pyproject_toml"]
 
+
 def update_pyproject_dependencies(dependencies: dict, schedule: SupportSchedule):
     # Iterate by idx because we want to update it inplace
     for i in range(len(dependencies)):
@@ -75,15 +76,17 @@ def update_dependency_table(dep_table: dict, new_versions: dict):
 
 
 def update_pixi_dependencies(pixi_tables: dict, schedule: SupportSchedule):
-    if "pypi-dependencies" in pixi_tables: 
+    if "pypi-dependencies" in pixi_tables:
         update_dependency_table(pixi_tables["pypi-dependencies"], schedule["packages"])
-    if "dependencies" in pixi_tables: 
+    if "dependencies" in pixi_tables:
         update_dependency_table(pixi_tables["dependencies"], schedule["packages"])
 
     if "feature" in pixi_tables:
         for _, feature_data in pixi_tables["feature"].items():
             if "dependencies" in feature_data:
-                update_dependency_table(feature_data["dependencies"], schedule["packages"])
+                update_dependency_table(
+                    feature_data["dependencies"], schedule["packages"]
+                )
 
 
 def update_pyproject_toml(
@@ -114,6 +117,6 @@ def update_pyproject_toml(
         pyproject_data["project"]["dependencies"], new_version
     )
 
-    if "tool" in pyproject_data and "pixi" in pyproject_data['tool']:
+    if "tool" in pyproject_data and "pixi" in pyproject_data["tool"]:
         pixi_data = pyproject_data["tool"]["pixi"]
         update_pixi_dependencies(pixi_data, new_version)

spec0_action/parsing.py

@@ -62,7 +62,9 @@ def read_schedule(path: Path | str) -> Sequence[SupportSchedule]:
         return json.load(file)
 
 
-def parse_pep_dependency(dep_str: str) -> Tuple[str, str | None, SpecifierSet | Url | None]:
+def parse_pep_dependency(
+    dep_str: str,
+) -> Tuple[str, str | None, SpecifierSet | Url | None]:
     match = PEP_PACKAGE_IDENT_RE.match(dep_str)
     if match is None:
         raise ValueError("Could not find any valid python package identifier")
@@ -81,7 +83,7 @@ def parse_pep_dependency(dep_str: str) -> Tuple[str, str | None, SpecifierSet |
     return (pkg, extras, spec)
 
 
-def is_url_spec(str_spec: str|None) -> bool:
+def is_url_spec(str_spec: str | None) -> bool:
     if str_spec is None:
         return False
 

tests/test_parsing.py

@@ -37,6 +37,7 @@ def test_pep_dependency_parsing_with_spec_and_optional_dep():
     assert features == "[foo,bar]", features
     assert spec == SpecifierSet(">=3.7.0,<4"), spec
 
+
 def test_pep_dependency_parsing_with_spec():
     matplotlib_str = "matplotlib>=3.7.0,<4"
     pkg, features, spec = parse_pep_dependency(matplotlib_str)