git_alert 0.1.0__tar.gz

git_alert-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Simon Antonius Lauer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

git_alert-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.1
+Name: git_alert
+Version: 0.1.0
+Summary: Checks a given path and its sub-directories for dirty git repositories.
+License: MIT
+Author: Simon Antonius Lauer
+Author-email: simon.lauer@posteo.de
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+
+# Git Alert
+
+<hr>
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+![Codecov](https://img.shields.io/codecov/c/github/nomisreual/git_alert)
+
+This is a Python application that checks in the given directory and all its subdirectories
+for any dirty repositories.
+
+This application aims to ease the frequent use of git as it makes it easy to check for any untracked changes in any of your repositories.
+
+## Installation:
+
+The application is now available on PyPI, so you can install it using pip:
+
+```
+pip install git_alert
+```
+
+Alternatively, you can use pipx to make it globally available:
+
+```
+pipx install git_alert
+```
+
+Of course you can also clone the repository and install it manually. The package is built using poetry, so the easiest way to build it locally would be
+to use poetry:
+
+```
+git clone https://github.com/nomisreual/git_alert.git
+cd git_alert
+poetry build
+```
+
+After the build, you can install it either using pip or pipx:
+
+```
+pip install -e .
+```
+
+or
+
+```
+pipx install .
+```
+
+## Usage:
+
+You can use _git_alert_ by either calling it as a module (`python -m git_alert`) or by directly using the installed package:
+
+```
+usage: git_alert [-h] [--path PATH] [--only_dirty]
+
+options:
+  -h, --help    show this help message and exit
+  --path PATH   top level directory to start the search in
+  --only_dirty  only show dirty repositories in the final report
+```
+
+## Development:
+
+The tool is aimed to be improved and extended going forward. If you have any ideas or want to contribute, feel free to open an issue or a pull request.
+
+## Goals:
+
+- [ ] more detailed checks (currently it distinguishes only between a repository being clean or not)
+- [ ] speed up the lookup process
+- [ ] enable caching found repositories for faster checking after the first run (maybe utilizing a database)
+- [ ] GUI interface
+
+## Contributing:
+
+This project is under active development, so any contributions are welcome. Feel free to open an issue or a pull request.
+
+In case you want to submit a pull request, please:
+
+- make sure to run the tests before submission
+- use black for code formatting
+
+The project uses pre-commit hooks to ensure code quality, so feel free to use them as well.
+

git_alert-0.1.0/README.md

@@ -0,0 +1,81 @@
+# Git Alert
+
+<hr>
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+![Codecov](https://img.shields.io/codecov/c/github/nomisreual/git_alert)
+
+This is a Python application that checks in the given directory and all its subdirectories
+for any dirty repositories.
+
+This application aims to ease the frequent use of git as it makes it easy to check for any untracked changes in any of your repositories.
+
+## Installation:
+
+The application is now available on PyPI, so you can install it using pip:
+
+```
+pip install git_alert
+```
+
+Alternatively, you can use pipx to make it globally available:
+
+```
+pipx install git_alert
+```
+
+Of course you can also clone the repository and install it manually. The package is built using poetry, so the easiest way to build it locally would be
+to use poetry:
+
+```
+git clone https://github.com/nomisreual/git_alert.git
+cd git_alert
+poetry build
+```
+
+After the build, you can install it either using pip or pipx:
+
+```
+pip install -e .
+```
+
+or
+
+```
+pipx install .
+```
+
+## Usage:
+
+You can use _git_alert_ by either calling it as a module (`python -m git_alert`) or by directly using the installed package:
+
+```
+usage: git_alert [-h] [--path PATH] [--only_dirty]
+
+options:
+  -h, --help    show this help message and exit
+  --path PATH   top level directory to start the search in
+  --only_dirty  only show dirty repositories in the final report
+```
+
+## Development:
+
+The tool is aimed to be improved and extended going forward. If you have any ideas or want to contribute, feel free to open an issue or a pull request.
+
+## Goals:
+
+- [ ] more detailed checks (currently it distinguishes only between a repository being clean or not)
+- [ ] speed up the lookup process
+- [ ] enable caching found repositories for faster checking after the first run (maybe utilizing a database)
+- [ ] GUI interface
+
+## Contributing:
+
+This project is under active development, so any contributions are welcome. Feel free to open an issue or a pull request.
+
+In case you want to submit a pull request, please:
+
+- make sure to run the tests before submission
+- use black for code formatting
+
+The project uses pre-commit hooks to ensure code quality, so feel free to use them as well.

git_alert-0.1.0/git_alert/__init__.py

@@ -0,0 +1,3 @@
+from git_alert.argument_parser import argument_parser
+from git_alert.repositories import Repositories
+from git_alert.traverse import GitAlert

git_alert-0.1.0/git_alert/__main__.py

@@ -0,0 +1,14 @@
+import sys
+
+from git_alert.argument_parser import argument_parser
+from git_alert.repositories import Repositories
+from git_alert.traverse import GitAlert
+
+repos = Repositories()
+
+args = argument_parser(sys.argv[1:])
+
+alert = GitAlert(args.path, repos)
+
+alert.traverse(args.path)
+alert.repos.display(only_dirty=args.only_dirty)

git_alert-0.1.0/git_alert/argument_parser.py

@@ -0,0 +1,23 @@
+from argparse import ArgumentParser, Namespace
+from pathlib import Path
+
+
+def argument_parser(args) -> Namespace:
+    """
+    Create argument parser providing two arguments:
+    --path: Path, default: Path.cwd()
+    --only_dirty: bool, default: False
+    """
+    parser = ArgumentParser()
+    parser.add_argument(
+        "--path",
+        type=Path,
+        default=Path.cwd(),
+        help="top level directory to start the search in",
+    )
+    parser.add_argument(
+        "--only_dirty",
+        action="store_true",
+        help="only show dirty repositories in the final report",
+    )
+    return parser.parse_args(args)

git_alert-0.1.0/git_alert/repositories.py

@@ -0,0 +1,26 @@
+from pathlib import Path
+
+
+class Repositories:
+    def __init__(self) -> None:
+        self.repos: list[dict[Path, str]] = []
+
+    def add_repo(self, repo: dict[Path, str]) -> None:
+        """
+        Add a repository to the list of repositories.
+        args:
+            repo: dict[Path, str]
+        """
+        self.repos.append(repo)
+
+    def display(self, only_dirty: bool) -> None:
+        """
+        Display the repositories.
+        args:
+            only_dirty: bool
+        """
+        for repo in self.repos:
+            for key, value in repo.items():
+                if only_dirty and value == "clean":
+                    continue
+                print(f"Repository: {key} is {value}")

git_alert-0.1.0/git_alert/scripts/git_alert.py

@@ -0,0 +1,16 @@
+import sys
+
+from git_alert.argument_parser import argument_parser
+from git_alert.repositories import Repositories
+from git_alert.traverse import GitAlert
+
+
+def run():
+    repos = Repositories()
+
+    args = argument_parser(sys.argv[1:])
+
+    alert = GitAlert(args.path, repos)
+
+    alert.traverse(args.path)
+    alert.repos.display(only_dirty=args.only_dirty)

git_alert-0.1.0/git_alert/traverse.py

@@ -0,0 +1,50 @@
+# traverse.py
+import subprocess
+import sys
+from pathlib import Path
+
+from git_alert.repositories import Repositories
+
+
+class GitAlert:
+    def __init__(self, pth: Path, repos: Repositories):
+        self._pth = pth
+        self._repos = repos
+
+    def traverse(self, pth: Path) -> None:
+        """
+        Traverse the directory and its subdirectories and check if it is a git repository.
+        args:
+            pth: Path
+        """
+        try:
+            files = pth.glob("*")
+            for file in files:
+                if file.is_dir() and file.name == ".git":
+                    self.check(file)
+
+                elif file.is_dir():
+                    self.traverse(file)
+        except PermissionError:
+            print(f"Warning: no access to: {pth}", file=sys.stderr)
+
+    def check(self, pth: Path) -> None:
+        """
+        Check if the git repository is clean or dirty.
+        args:
+            pth: Path
+        """
+        repo = {}
+        output = subprocess.run(
+            ["git", "status"], cwd=pth.parent, stdout=subprocess.PIPE
+        )
+        if "working tree clean" in output.stdout.decode():
+            repo[pth.parent] = "clean"
+            self._repos.add_repo(repo)
+        else:
+            repo[pth.parent] = "dirty"
+            self._repos.add_repo(repo)
+
+    @property
+    def repos(self) -> Repositories:
+        return self._repos

git_alert-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[tool.poetry]
+name = "git_alert"
+version = "0.1.0"
+description = "Checks a given path and its sub-directories for dirty git repositories."
+authors = ["Simon Antonius Lauer <simon.lauer@posteo.de>"]
+readme = "README.md"
+license = "MIT"
+packages = [{include = "git_alert"}]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.1.1"
+pytest-cov = "^5.0.0"
+
+
+[tool.poetry.group.development.dependencies]
+flake8 = "^7.0.0"
+black = "^24.3.0"
+pre-commit = "^3.7.0"
+
+
+[tool.poetry.group.publish.dependencies]
+badgie = "^0.12.0"
+coverage = "^7.4.4"
+coverage-badge = "^1.1.0"
+
+[tool.poetry.scripts]
+git_alert = "git_alert.scripts.git_alert:run"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"