git-bot-feedback 0.0.1__cp310-abi3-win_amd64.whl

git_bot_feedback/__init__.py

@@ -0,0 +1,5 @@
+from .git_bot_feedback import *
+
+__doc__ = git_bot_feedback.__doc__
+if hasattr(git_bot_feedback, "__all__"):
+    __all__ = git_bot_feedback.__all__

git_bot_feedback/__init__.pyi

@@ -0,0 +1,240 @@
+from enum import Enum
+from pathlib import Path
+from typing import NamedTuple
+
+class GitClient:
+    def __init__(self) -> None: ...
+    def is_pr_event(self) -> bool: ...
+    def is_debug_enabled(self) -> bool: ...
+    @property
+    def event_name(self) -> str | None: ...
+    def set_user_agent(self, user_agent: str) -> None: ...
+    async def get_list_of_changed_files(
+        self,
+        file_filter: FileFilter,
+        lines_changed_only: LinesChangedOnly,
+        base_diff: str | None = None,
+        ignore_index: bool = False,
+    ) -> dict[str, FileDiffLines]: ...
+    async def post_thread_comment(self, options: ThreadCommentOptions) -> None: ...
+    def append_step_summary(self, comment: str) -> None: ...
+    async def cull_pr_reviews(self, options: ReviewOptions) -> ReviewOptions: ...
+    async def post_pr_review(self, options: ReviewOptions) -> None: ...
+    def write_output_variables(
+        self, output_variables: list[OutputVariable]
+    ) -> None: ...
+    def write_file_annotations(self, annotations: list[FileAnnotation]) -> None: ...
+    @property
+    def client_kind(self) -> str: ...
+
+class OutputVariable:
+    def __init__(self, name: str, value: str) -> None: ...
+    def validate(self) -> bool: ...
+    @property
+    def name(self) -> str: ...
+    @name.setter
+    def name(self, name: str) -> None: ...
+    @property
+    def value(self) -> str: ...
+    @value.setter
+    def value(self, value: str) -> None: ...
+
+class AnnotationLevel(Enum):
+    Debug = ...
+    Notice = ...
+    Warning = ...
+    Error = ...
+
+class FileAnnotation:
+    def __init__(
+        self,
+        severity: AnnotationLevel,
+        path: str,
+        message: str,
+        start_line: int | None = None,
+        end_line: int | None = None,
+        start_column: int | None = None,
+        end_column: int | None = None,
+        title: str | None = None,
+    ) -> None: ...
+    @property
+    def severity(self) -> AnnotationLevel: ...
+    @severity.setter
+    def severity(self, val: AnnotationLevel) -> None: ...
+    @property
+    def path(self) -> str: ...
+    @path.setter
+    def path(self, val: str) -> None: ...
+    @property
+    def message(self) -> str: ...
+    @message.setter
+    def message(self, val: str) -> None: ...
+    @property
+    def start_line(self) -> int | None: ...
+    @start_line.setter
+    def start_line(self, val: int | None) -> None: ...
+    @property
+    def end_line(self) -> int | None: ...
+    @end_line.setter
+    def end_line(self, val: int | None) -> None: ...
+    @property
+    def start_column(self) -> int | None: ...
+    @start_column.setter
+    def start_column(self, val: int | None) -> None: ...
+    @property
+    def end_column(self) -> int | None: ...
+    @end_column.setter
+    def end_column(self, val: int | None) -> None: ...
+    @property
+    def title(self) -> str | None: ...
+    @title.setter
+    def title(self, val: str | None) -> None: ...
+
+class DiffHunkHeader(NamedTuple):
+    old_start: int
+    old_lines: int
+    new_start: int
+    new_lines: int
+
+class FileDiffLines:
+    def __init__(self) -> None: ...
+    def is_hunk_in_diff(self, hunk: DiffHunkHeader) -> tuple[int, int] | None: ...
+    def is_line_in_diff(self, line: int) -> bool: ...
+    @property
+    def added_lines(self) -> list[int]: ...
+    @property
+    def added_ranges(self) -> list[tuple[int, int]]: ...
+    @property
+    def diff_hunks(self) -> list[tuple[int, int]]: ...
+
+class FileFilter:
+    def __init__(
+        self, ignore: list[str], extensions: list[str], log_scope: str | None = None
+    ) -> None: ...
+    def parse_submodules(self, manifest_path: str | Path | None = None) -> None: ...
+    def is_file_in_list(self, file_path: str | Path, ignored: bool) -> bool: ...
+    def is_file_ignored(self, file_path: str | Path) -> bool: ...
+    def is_file_not_ignored(self, file_path: str | Path) -> bool: ...
+    def is_qualified(self, file_path: str | Path) -> bool: ...
+    def walk_dir(self, root_path: str | Path) -> set[str]: ...
+    @property
+    def extensions(self) -> set[str]: ...
+    @property
+    def ignored(self) -> set[str]: ...
+    @property
+    def not_ignored(self) -> set[str]: ...
+
+class LinesChangedOnly(Enum):
+    On = ...
+    Off = ...
+    Diff = ...
+
+def parse_diff(
+    diff: str,
+    file_filter: FileFilter,
+    lines_changed_only: LinesChangedOnly | None = None,
+) -> dict[str, FileDiffLines]: ...
+
+class ReviewAction(Enum):
+    Approve = ...
+    RequestChanges = ...
+    Comment = ...
+
+class ReviewComment:
+    def __init__(
+        self, path: str, comment: str, line_end: int, line_start: int | None = None
+    ) -> None: ...
+    @property
+    def line_start(self) -> int | None: ...
+    @line_start.setter
+    def line_start(self, val: int | None) -> None: ...
+    @property
+    def line_end(self) -> int: ...
+    @line_end.setter
+    def line_end(self, val: int) -> None: ...
+    @property
+    def comment(self) -> str: ...
+    @comment.setter
+    def comment(self, val: str) -> None: ...
+    @property
+    def path(self) -> str: ...
+    @path.setter
+    def path(self, val: str) -> None: ...
+
+class ReviewOptions:
+    def __init__(
+        self,
+        comments: list[ReviewComment],
+        action: ReviewAction | None = None,
+        summary: str | None = None,
+        marker: str | None = None,
+        allow_draft: bool = False,
+        allow_closed: bool = False,
+        delete_review_comments: bool = False,
+    ) -> None: ...
+    @property
+    def comments(self) -> list[ReviewComment]: ...
+    @comments.setter
+    def comments(self, val: list[ReviewComment]) -> None: ...
+    @property
+    def action(self) -> ReviewAction | None: ...
+    @action.setter
+    def action(self, val: ReviewAction) -> None: ...
+    @property
+    def summary(self) -> str | None: ...
+    @summary.setter
+    def summary(self, val: str) -> None: ...
+    @property
+    def marker(self) -> str: ...
+    @marker.setter
+    def marker(self, val: str) -> None: ...
+    @property
+    def allow_draft(self) -> bool: ...
+    @allow_draft.setter
+    def allow_draft(self, val: bool) -> None: ...
+    @property
+    def allow_closed(self) -> bool: ...
+    @allow_closed.setter
+    def allow_closed(self, val: bool) -> None: ...
+    @property
+    def delete_review_comments(self) -> bool: ...
+    @delete_review_comments.setter
+    def delete_review_comments(self, val: bool) -> None: ...
+
+class CommentKind(Enum):
+    Concerns = ...
+    Lgtm = ...
+
+class CommentPolicy(Enum):
+    Anew = ...
+    Update = ...
+
+class ThreadCommentOptions:
+    def __init__(
+        self,
+        policy: CommentPolicy | None = None,
+        comment: str | None = None,
+        kind: CommentKind | None = None,
+        marker: str | None = None,
+        no_lgtm: bool = False,
+    ) -> None: ...
+    @property
+    def policy(self) -> CommentPolicy | None: ...
+    @policy.setter
+    def policy(self, val: CommentPolicy) -> None: ...
+    @property
+    def comment(self) -> str | None: ...
+    @comment.setter
+    def comment(self, val: str) -> None: ...
+    @property
+    def kind(self) -> CommentKind | None: ...
+    @kind.setter
+    def kind(self, val: CommentKind) -> None: ...
+    @property
+    def marker(self) -> str | None: ...
+    @marker.setter
+    def marker(self, val: str) -> None: ...
+    @property
+    def no_lgtm(self) -> bool: ...
+    @no_lgtm.setter
+    def no_lgtm(self, val: bool) -> None: ...

git_bot_feedback-0.0.1.dist-info/METADATA

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: git-bot-feedback
+Version: 0.0.1
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Information Technology
+Classifier: Natural Language :: English
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Summary: A Python library (written in Rust) designed for CI tools to easily submit feedback on a git server.
+Keywords: git,client,github,bot,rust
+Author-email: Brendan Doherty <2bndy5@gmail.com>
+License: GPL-3.0-or-later
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst; charset=UTF-8
+Project-URL: source, https://github.com/2bndy5/git-bot-feedback
+Project-URL: tracker, https://github.com/2bndy5/git-bot-feedback/issues
+
+================
+git-bot-feedback
+================
+
+|pypi-badge|
+|py-ci-badge|
+|docs-badge|
+|license-badge|
+
+A Python library (written in Rust) designed for CI tools to easily submit feedback on a git server.
+
+Feedback on a git server using this library can be in the form of
+
+- thread comments (for a PR or commit)
+- setting output variables for other CI tools to consume
+- append a summary comment to a CI workflow run's summary page
+- mark the start and end of a group of log statements (in the CI workflow run's
+  logs)
+- files annotations
+- Pull Request reviews
+- get a list of changed files in a PR or commit (including line numbers shown in the diff)
+
+This uses async functions to access network resources. Thus, an ``asyncio`` event
+loop is required.
+
+Supported git servers
+---------------------
+
+Initially, this project is designed to work with GitHub.
+But the API is designed to easily add support for other git servers.
+The following is just a list of git servers that are planned (in order or priority).
+
+- GitHub
+- GitLab
+- Gitea
+- BitBucket
+
+GPL license
+-----------
+
+.. _GPL-3.0-or-later: https://github.com/2bndy5/git-bot-feedback/blob/main/LICENSE
+
+This project is licensed under `GPL-3.0-or-later`_.
+
+Since this library ultimately requires write access to
+users' projects (to allow posting comments),
+it could easily be modified with malicious intent.
+
+By using the `GPL-3.0-or-later`_ license,
+we can offer some assurance and help safeguard end-users' data/privacy
+because the following conditions must be met:
+
+- the source code is publicly available
+- any redistributed forms must state their modifications (if any)
+- any redistributed forms must use the same `GPL-3.0-or-later`_ license
+
+.. |docs-badge| image:: https://img.shields.io/github/deployments/2bndy5/git-bot-feedback/github-pages?logo=github&label=docs
+   :alt: GitHub pages
+   :target: https://2bndy5.github.io/git-bot-feedback
+.. |license-badge| image:: https://img.shields.io/github/license/2bndy5/git-bot-feedback
+   :alt: GitHub License
+   :target: https://github.com/2bndy5/git-bot-feedback/blob/main/LICENSE
+.. |py-ci-badge| image:: https://github.com/2bndy5/git-bot-feedback/actions/workflows/python.yml/badge.svg
+    :alt: Python CI
+    :target: https://github.com/2bndy5/git-bot-feedback/actions/workflows/python.yml
+.. |pypi-badge| image:: https://img.shields.io/pypi/v/git-bot-feedback
+   :alt: PyPI Version
+   :target: https://pypi.org/project/git-bot-feedback
+

git_bot_feedback-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+git_bot_feedback/__init__.py,sha256=szE2DOFTYtupkw_Mvrp6YWME0VWL4LPD-gExPALlZQ4,147
+git_bot_feedback/__init__.pyi,sha256=sjNYpBEM24rjjlQVTIVZY57mb3CelGv_rEf1BIrXZJ8,7591
+git_bot_feedback/git_bot_feedback.pyd,sha256=_wPf37NJoFMnDGGNQBfjcKc_VBcdLtR2h6hVTSxpuW4,8043520
+git_bot_feedback/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+git_bot_feedback-0.0.1.dist-info/METADATA,sha256=NzSJ8R74YB9ImFmQ4wUCg7__1b7oEIkHBlvaIZhAFWI,3627
+git_bot_feedback-0.0.1.dist-info/WHEEL,sha256=_qjkWZs5yrFgc7wGyX42BWq6PiACrY0XI82VSrZ_57E,96
+git_bot_feedback-0.0.1.dist-info/sboms/git-bot-feedback-py.cyclonedx.json,sha256=8uY2Hli0uM8vMyTMrhUGmJn_MfwROBLM10wKK-9Tbnk,187529
+git_bot_feedback-0.0.1.dist-info/RECORD,,

git_bot_feedback-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: cp310-abi3-win_amd64