git-bot-feedback 0.0.1__tar.gz

git_bot_feedback-0.0.1/.gitattributes

@@ -0,0 +1,21 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.py text eol=lf
+*.css text eol=lf
+*.md text eol=lf
+*.rst text eol=lf
+*.rs text eol=lf
+*.yml text eol=lf
+*.yaml text eol=lf
+*.json text eol=lf
+*.toml text eol=lf
+*.lock text eol=lf
+.gitattributes text eol=lf
+.gitignore text eol=lf
+**.gitmodules text eol=lf
+*.txt text eol=lf
+*.nu text eol=lf
+nurfile text eol=lf

git_bot_feedback-0.0.1/.gitignore

@@ -0,0 +1,194 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,rust
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,rust
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Rust ###
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# End of https://www.toptal.com/developers/gitignore/api/python,rust
+
+# generated release notes
+*/ReleaseNotes.md
+
+# coverage reports
+lcov.info
+coverage.json

git_bot_feedback-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-toml
+    - id: check-added-large-files
+    - id: mixed-line-ending
+      args: ['--fix=lf']
+- repo: https://github.com/streetsidesoftware/cspell-cli
+  rev: v10.0.1
+  hooks:
+    - id: cspell
+      exclude: CHANGELOG.md$
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.15.20
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+    # Run the formatter.
+    - id: ruff-format
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v2.1.0
+  hooks:
+    - id: mypy

git_bot_feedback-0.0.1/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+<!-- markdownlint-disable MD024 -->
+
+## [git-bot-feedback/v0.7.0] - 2026-06-29
+
+### <!-- 1 --> 🚀 Added
+
+- Implement GitHub client by @2bndy5 in [#1](https://github.com/2bndy5/git-bot-feedback/pull/1)
+- List file changes by @2bndy5 in [#11](https://github.com/2bndy5/git-bot-feedback/pull/11)
+- Allow custom base for local diff by @2bndy5 in [#30](https://github.com/2bndy5/git-bot-feedback/pull/30)
+- Propagate more errors to user for adequate handling by @2bndy5 in [#31](https://github.com/2bndy5/git-bot-feedback/pull/31)
+- Use helper functions to reduce error handling code by @2bndy5 in [#33](https://github.com/2bndy5/git-bot-feedback/pull/33)
+- Comprehensive output variable validation by @2bndy5 in [#35](https://github.com/2bndy5/git-bot-feedback/pull/35)
+- Support file annotations by @2bndy5 in [#37](https://github.com/2bndy5/git-bot-feedback/pull/37)
+- Support PR reviews by @2bndy5 in [#34](https://github.com/2bndy5/git-bot-feedback/pull/34)
+- Expose `debug_enabled` and `event_name` by @2bndy5 in [#60](https://github.com/2bndy5/git-bot-feedback/pull/60)
+- Implement Display for LinesChangedOnly by @2bndy5 in [#59](https://github.com/2bndy5/git-bot-feedback/pull/59)
+- Add `init_client()` and `LocalClient` by @2bndy5 in [#61](https://github.com/2bndy5/git-bot-feedback/pull/61)
+- Allow custom user-agent header value by @2bndy5 in [#62](https://github.com/2bndy5/git-bot-feedback/pull/62)
+- Revise `FileFilter::walk_dir()` by @2bndy5 in [#78](https://github.com/2bndy5/git-bot-feedback/pull/78)
+- Strip parent path from `walk_dir()` results by @2bndy5 in [#83](https://github.com/2bndy5/git-bot-feedback/pull/83)
+- Add python bindings by @2bndy5 in [#90](https://github.com/2bndy5/git-bot-feedback/pull/90)
+
+### <!-- 10 --> 💥 Breaking Changes
+
+- Rename `FileFilter::is_not_ignored()` to `is_qualified()` by @2bndy5 in [#57](https://github.com/2bndy5/git-bot-feedback/pull/57)
+
+### <!-- 4 --> 🛠️ Fixed
+
+- Use synchronous `std::{fs, process::Command}` by @2bndy5 in [#29](https://github.com/2bndy5/git-bot-feedback/pull/29)
+- Make `RestApiClient` a dyn-compatible async trait by @2bndy5 in [#36](https://github.com/2bndy5/git-bot-feedback/pull/36)
+- Remove `async` from non-async functions by @2bndy5 in [#58](https://github.com/2bndy5/git-bot-feedback/pull/58)
+- Use stricter linting rules by @2bndy5 in [#63](https://github.com/2bndy5/git-bot-feedback/pull/63)
+- Write only 1 LF for GH output vars by @2bndy5 in [`7add27b`](https://github.com/2bndy5/git-bot-feedback/commit/7add27b0637d65e2741e05eb55e3e3e712f46236)
+- Honor `ignore_index` when asserted by @2bndy5 in [#75](https://github.com/2bndy5/git-bot-feedback/pull/75)
+- Strip relative path from `FileFilter::walk_dir()` results by @2bndy5 in [#84](https://github.com/2bndy5/git-bot-feedback/pull/84)
+- Use correct name of PR review state that is "COMMENTED" by @2bndy5 in [#89](https://github.com/2bndy5/git-bot-feedback/pull/89)
+
+### <!-- 9 --> 🗨️ Changed
+
+- Revise `FileAnnotations` impl by @2bndy5 in [#64](https://github.com/2bndy5/git-bot-feedback/pull/64)
+
+[git-bot-feedback/v0.7.0]: https://github.com/2bndy5/git-bot-feedback/compare/git-bot-feedback/v0.6.1...git-bot-feedback/v0.7.0
+
+Full commit diff: [`git-bot-feedback/v0.6.1...git-bot-feedback/v0.7.0`][git-bot-feedback/v0.7.0]
+
+
+<!-- generated by git-cliff -->

git_bot_feedback-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,166 @@
+<!-- markdownlint-disable MD033 -->
+
+# Contribution guidelines
+
+First, thank you for considering a contribution to this project!
+
+This document should help detail the project's expectations about contributions.
+
+## Development tools
+
+This project uses the following tools for development:
+
+- [cargo-llvm-cov] for measuring code coverage.
+- [cargo-nextest] as a testing harness.
+- [nur] for running common tasks in the development workflow.
+
+### Optional tools
+
+- [committed] for verifying commit messages conform to [conventional commits]
+  standards.
+- [git-cliff] for generating a [Changelog](CHANGELOG.md) and release notes.
+- [pre-commit] for sanitizing project files.
+
+[cargo-llvm-cov]: https://crates.io/crates/cargo-llvm-cov
+[cargo-nextest]: https://crates.io/crates/cargo-nextest
+[nur]: https://crates.io/crates/nur
+[committed]: https://crates.io/crates/committed
+[conventional commits]: https://www.conventionalcommits.org
+[git-cliff]: https://crates.io/crates/git-cliff
+[pre-commit]: https://pre-commit.com
+
+## Submitting patches
+
+Please, please, please open an issue to discuss possible solutions before
+submitting a Pull Request. If it is a small patch (ie 1 or 2 lines), then a
+preemptive issue may not be warranted. Although, it still helps to first discuss
+the reason of the small patch in some manor.
+
+Pull Request titles should conform to [conventional commits] standard. Upon
+merging the Pull Request, all commits on the feature branch are squashed into a
+single commit pushed to the default (main) branch. This is done so [git-cliff]
+can adequately generate a list of changes when processing a release.
+
+## Code style
+
+[uv]: https://docs.astral.sh/uv
+[pipx]: https://pipx.pypa.io/stable
+
+This project's CI leverages [pre-commit] to ensure
+
+- [x] line ending all use LF (not CRLF)
+- [x] lines have no trailing whitespace
+- [x] files end with a blank line
+- [x] valid syntax is used in all yaml and toml files
+- [x] no large files (greater than 500 kB) are added
+- [x] no unknown or misspelled words are present
+
+Normally, [pre-commit] is typically run from a Python virtual environment. This
+project has no other practical need for a Python virtual environment. Instead,
+[pre-commit] can be run as with a one-line command using [uv], [pipx], or [nur]
+
+```shell
+pipx run pre-commit run --all-files
+```
+
+```shell
+uvx pre-commit run --all-files
+```
+
+```shell
+nur pre-commit
+```
+
+By default, the [nur] `pre-commit` task uses the [uv] command stated above.
+Optional arguments are documented and shown in `nur pre-commit -h`.
+
+### Static analysis
+
+Code format and linting is done by using `cargo clippy` and `cargo fmt`. Both
+commands are performed using a [nur] task as well:
+
+```shell
+nur lint
+```
+
+## Testing
+
+> [!WARNING]
+> Do not use `cargo test` to run this project's tests. This project's tests
+> heavy rely on manipulating environment variables. Instead, this project
+> leverages [cargo-nextest] to isolate each test with it's own environment
+> context. See
+> [cargo-nextest documentation about altering environment variables][cargo-nextest-env-docs].
+
+[cargo-nextest-env-docs]: https://nexte.st/docs/configuration/env-vars/#altering-the-environment-within-tests
+
+To collect code coverage, this project uses [cargo-llvm-cov] which natively
+supports [cargo-nextest]. However, the commands to run [cargo-llvm-cov] and
+[cargo-nextest] tools in tandem can be lengthy. We use [nur] to parametrize the
+various test options (applicable to this project) into tasks.
+
+### Running tests
+
+Unit tests are performed using [cargo-nextest] while coverage is measured by
+[cargo-llvm-cov].
+
+#### Run the tests
+
+```shell
+nur test
+```
+
+Optional arguments are documented and shown in `nur test -h`.
+
+<details><summary>Mimicking CI test runs</summary>
+
+The `default` test profile skips tests that are known to run longer than 10
+seconds and only shows verbose output for tests that fail. The `ci` test profile
+includes slow tests and enables more verbose output. To enable the `ci` test
+profile, simply pass `--profile ci` (or `-p ci`) to the `nur test` command:
+
+```shell
+nur test -p ci
+```
+
+</details>
+
+#### Generate coverage report
+
+```shell
+nut test llvm-cov
+```
+
+> [!TIP]
+> Additional arguments (except `-h` and `--help`) passed to `nur test llvm-cov`
+> are passed onto [cargo-llvm-cov].
+>
+> Pass `--open` to automatically open the built coverage report in your default
+> browser.
+
+<details><summary>Generating lcov.info</summary>
+
+A "lcov.info" file is uploaded to codecov. Some developer tooling might also
+make use of the lcov format (eg. the VS Code ext named "Coverage Gutters"). This
+lcov.info file can be created with our [nur] task:
+
+```shell
+nur test lcov
+```
+
+</details>
+
+## API documentation
+
+Documentation is hosted at docs.rs automatically upon release. To verify any
+documentation changes locally, we can use [nur] for that too:
+
+```shell
+nur docs
+```
+
+> [!TIP]
+> Optional arguments are documented and shown in `nur docs -h`.
+>
+> Pass `--open` (or `-o`) to automatically open the built documentation in your
+> default browser.