Add packaging as a dependency, update README, remove project_path from CLI

Author: robbievanleeuwen

README.md

@@ -3,25 +3,59 @@
 CLI tool to check for dependency updates in your python project. Automatically creates
 GitHub pull requests for dependencies you wish to update!
 
+## Usage
+
+If you have `uv` installed, you can install `upgrade-dependencies` with
+
+```
+uv tool install upgrade-dependencies
+```
+
+You can then navigate to your project directory and execute:
+
+```
+uvx upgrade-dependencies [OPTIONS] [COMMAND]
+```
+
+### Requirements
+
+All python requirements are installed by default. To successfully use the `update`
+command the following executables must be installed into your shell:
+
+- `git`
+- `gh`, i.e. GitHub CLI - ensure you have already run `gh auth login` and added
+  appropriate permissions
+
+### GitHub API Rate Limit
+
+The GitHub API is used to fetch data for GitHub actions and `pre-commit` repos.
+Unauthenticated users have a rate limit of 60 requests per hour, whereas authenticated
+users have a rate limit of 5,000 requests per hour. You can use a GitHub personal access
+token to utilise this higher rate limit by setting the `GH_PAT` environment variable:
+
+```
+export GH_PAT=github_pat_xxx
+```
+
 ## Limitations
 
-- Currently only supports a single specifier.
-- File structure is fixed
-- GH actions must only use major version
-- Recommend to have a clean git before running (or at least no changes to pyproject etc.)
-
-## TODO
-
-- [x] Async data retrieval
-- [x] Get dependencies from github actions
-- [x] Get uv dependency from github actions
-- [x] Get dependencies from pre-commit
-- [x] Github auth & async
-- [x] Create dependency abstract class
-- [x] Use get_dependency
-- [x] Implement CLI
-- [x] Create changes to files
-- [ ] Handle uv better (not group)
-- [x] Create pull request
-- [ ] Documentation
-- [ ] Add tests
+- Currently only supports a single specifier, e.g. `numpy~=2.0.2`, not `numpy>=2,<2.1`
+- The project file structure is fixed and assumed, see
+  [Project File Structure](#project-file-structure).
+- GH actions must only use major version, e.g. `actions/checkout@v4` not
+  `actions/[email protected]`
+- It is recommended to have a clean git before running `update` (a warning will be
+  printed to the terminal if this is not the case).
+
+## Project File Structure
+
+The following project file structure is assumed:
+
+```
+project
+├── .github
+│   └── workflows
+│       └── *.yml
+├── .pre-commit-config.yml
+└── pyproject.toml
+```

pyproject.toml

@@ -10,13 +10,14 @@ authors = [
 requires-python = ">=3.13"
 dependencies = [
     "httpx~=0.27.2",
+    "packaging~=24.2",
     "ruamel-yaml~=0.18.6",
     "tomlkit~=0.13.2",
     "typer~=0.13.1",
 ]
 
 [project.scripts]
-up-deps = "upgrade_dependencies.main:main"
+upgrade-dependencies = "upgrade_dependencies.main:main"
 
 [dependency-groups]
 dev = [

src/upgrade_dependencies/main.py

@@ -24,16 +24,9 @@
 
 
 @app.command()
-def list_dependencies(project_path: str = ""):
-    """Checks whether a dependency needs updating.
-
-    Args:
-        project_path: Path to the project. Defaults to the current working directory.
-    """
-    project = Project(
-        project_path=project_path,
-        gh_pat=GH_PAT,
-    )
+def list_dependencies():
+    """Checks whether a dependency needs updating."""
+    project = Project(gh_pat=GH_PAT)
 
     # base dependencies
     title = Text("Base Dependencies", style="bold")
@@ -126,20 +119,13 @@ def list_dependencies(project_path: str = ""):
 
 
 @app.command()
-def check_dependency(
-    dependency: str,
-    project_path: str = "",
-):
+def check_dependency(dependency: str):
     """Checks whether a dependency needs updating.
 
     Args:
         dependency: Name of the dependency to check.
-        project_path: Path to the project. Defaults to the current working directory.
     """
-    project = Project(
-        project_path=project_path,
-        gh_pat=GH_PAT,
-    )
+    project = Project(gh_pat=GH_PAT)
 
     try:
         dep = project.get_dependency(name=dependency)
@@ -170,7 +156,6 @@ def check_dependency(
 
 @app.command()
 def needs_updating(
-    project_path: str = "",
     base: bool = True,
     optional_deps: bool = True,
     group_deps: bool = True,
@@ -180,7 +165,6 @@ def needs_updating(
     """List the dependencies that need updating.
 
     Args:
-        project_path: Path to the project. Defaults to the current working directory.
         base: If set to True, includes the base dependencies. Defaults to True.
         optional_deps: If set to True, includes the optional dependencies. Defaults to
             True.
@@ -191,10 +175,7 @@ def needs_updating(
             True.
     """
     # create project object
-    project = Project(
-        project_path=project_path,
-        gh_pat=GH_PAT,
-    )
+    project = Project(gh_pat=GH_PAT)
 
     # fetch relevant data
     if base or optional_deps or group_deps:
@@ -244,7 +225,6 @@ def needs_updating(
 
 @app.command()
 def latest_versions(
-    project_path: str = "",
     base: bool = True,
     optional_deps: bool = True,
     group_deps: bool = True,
@@ -254,7 +234,6 @@ def latest_versions(
     """List the dependencies that aren't pinned to the latest version.
 
     Args:
-        project_path: Path to the project. Defaults to the current working directory.
         base: If set to True, includes the base dependencies. Defaults to True.
         optional_deps: If set to True, includes the optional dependencies. Defaults to
             True.
@@ -265,10 +244,7 @@ def latest_versions(
             True.
     """
     # create project object
-    project = Project(
-        project_path=project_path,
-        gh_pat=GH_PAT,
-    )
+    project = Project(gh_pat=GH_PAT)
 
     # fetch relevant data
     if base or optional_deps or group_deps:
@@ -320,7 +296,7 @@ def latest_versions(
 def update(
     dependency: str,
     version: str | None = None,
-    project_path: str = "",
+    target_branch: str = "master",
 ):
     """_summary_.
 
@@ -329,18 +305,15 @@ def update(
     Args:
         dependency: _description_
         version: _description_
-        project_path: _description_
+        target_branch: _description_
     """
     with Progress(
         SpinnerColumn(),
         TextColumn("[progress.description]{task.description}"),
         transient=True,
     ) as progress:
         task = progress.add_task("Creating project...")
-        project = Project(
-            project_path=project_path,
-            gh_pat=GH_PAT,
-        )
+        project = Project(gh_pat=GH_PAT)
 
         # search for dependency and save old version
         try:
@@ -435,7 +408,7 @@ def update(
                 "-a",
                 "@me",
                 "--base",
-                "master",
+                target_branch,
                 "--body",
                 pr_body,
                 "--label",
@@ -445,10 +418,12 @@ def update(
             ],
         )
 
-        # re-checkout master
-        run_shell_command(["git", "checkout", "master"])
+        # re-checkout master branch
+        run_shell_command(["git", "checkout", target_branch])
 
-    rprint(f"✅ {dep.package_name} updated! View the pull request at {pr.stdout}")
+    msg = f"✅ [bold]{dep.package_name}[/bold] updated! View the pull request at"
+    msg += f" {pr.stdout}"
+    rprint(msg)
 
 
 def main():

src/upgrade_dependencies/project.py

@@ -23,7 +23,7 @@ class Project:
 
     def __init__(
         self,
-        project_path: str,
+        project_path: str = "",
         gh_pat: str | None = None,
     ) -> None:
         """_summary_.

todo.md

@@ -0,0 +1,16 @@
+# TODO
+
+- [x] Async data retrieval
+- [x] Get dependencies from github actions
+- [x] Get uv dependency from github actions
+- [x] Get dependencies from pre-commit
+- [x] Github auth & async
+- [x] Create dependency abstract class
+- [x] Use get_dependency
+- [x] Implement CLI
+- [x] Create changes to files
+- [ ] Handle uv better (not group)
+- [x] Create pull request
+- [ ] Add format yml files
+- [ ] Documentation
+- [ ] Add tests