arcade-github 0.1.13__tar.gz

arcade_github-0.1.13/.gitignore

@@ -0,0 +1,175 @@
+.DS_Store
+credentials.yaml
+docker/credentials.yaml
+
+*.lock
+
+# example data
+examples/data
+scratch
+
+
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# 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/

arcade_github-0.1.13/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+files: ^.*/github/.*
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

arcade_github-0.1.13/.ruff.toml

@@ -0,0 +1,46 @@
+target-version = "py310"
+line-length = 100
+fix = true
+
+[lint]
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+
+[lint.per-file-ignores]
+"*" = ["TRY003", "B904"]
+"**/tests/*" = ["S101", "E501"]
+"**/evals/*" = ["S101", "E501"]
+
+[format]
+preview = true
+skip-magic-trailing-comma = false

arcade_github-0.1.13/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, Arcade AI
+
+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.

arcade_github-0.1.13/Makefile

@@ -0,0 +1,55 @@
+.PHONY: help
+
+help:
+	@echo "🛠️ github Commands:\n"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: install
+install: ## Install the uv environment and install all packages with dependencies
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras --no-sources
+	@if [ -f .pre-commit-config.yaml ]; then uv run --no-sources pre-commit install; fi
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: install-local
+install-local: ## Install the uv environment and install all packages with dependencies with local Arcade sources
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras
+	@if [ -f .pre-commit-config.yaml ]; then uv run pre-commit install; fi
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: build
+build: clean-build ## Build wheel file using poetry
+	@echo "🚀 Creating wheel file"
+	uv build
+
+.PHONY: clean-build
+clean-build: ## clean build artifacts
+	@echo "🗑️ Cleaning dist directory"
+	rm -rf dist
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	@uv run --no-sources pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml
+
+.PHONY: coverage
+coverage: ## Generate coverage report
+	@echo "coverage report"
+	@uv run --no-sources coverage report
+	@echo "Generating coverage report"
+	@uv run --no-sources coverage html
+
+.PHONY: bump-version
+bump-version: ## Bump the version in the pyproject.toml file by a patch version
+	@echo "🚀 Bumping version in pyproject.toml"
+	uv version --no-sources --bump patch
+
+.PHONY: check
+check: ## Run code quality tools.
+	@if [ -f .pre-commit-config.yaml ]; then\
+		echo "🚀 Linting code: Running pre-commit";\
+		uv run --no-sources pre-commit run -a;\
+	fi
+	@echo "🚀 Static type checking: Running mypy"
+	@uv run --no-sources mypy --config-file=pyproject.toml

arcade_github-0.1.13/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: arcade_github
+Version: 0.1.13
+Summary: Arcade.dev LLM tools for Github
+Author-email: Arcade <dev@arcade.dev>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: arcade-tdk<3.0.0,>=2.0.0
+Requires-Dist: httpx<1.0.0,>=0.27.2
+Provides-Extra: dev
+Requires-Dist: arcade-ai[evals]<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: arcade-serve<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: mypy<1.6.0,>=1.5.1; extra == 'dev'
+Requires-Dist: pre-commit<3.5.0,>=3.4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio<0.25.0,>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov<4.1.0,>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-mock<3.12.0,>=3.11.1; extra == 'dev'
+Requires-Dist: pytest<8.4.0,>=8.3.0; extra == 'dev'
+Requires-Dist: ruff<0.8.0,>=0.7.4; extra == 'dev'
+Requires-Dist: tox<4.12.0,>=4.11.1; extra == 'dev'

arcade_github-0.1.13/arcade_github/tools/activity.py

@@ -0,0 +1,98 @@
+from typing import Annotated
+
+import httpx
+from arcade_tdk import ToolContext, tool
+from arcade_tdk.auth import GitHub
+
+from arcade_github.tools.utils import get_github_json_headers, get_url, handle_github_response
+
+
+# Implements https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#star-a-repository-for-the-authenticated-user and https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#unstar-a-repository-for-the-authenticated-user  # noqa: E501
+# Example `arcade chat` usage: "star the vscode repo owned by microsoft"
+@tool(requires_auth=GitHub())
+async def set_starred(
+    context: ToolContext,
+    owner: Annotated[str, "The owner of the repository"],
+    name: Annotated[str, "The name of the repository"],
+    starred: Annotated[bool, "Whether to star the repository or not"] = True,
+) -> Annotated[
+    str, "A message indicating whether the repository was successfully starred or unstarred"
+]:
+    """
+    Star or un-star a GitHub repository.
+    For example, to star microsoft/vscode, you would use:
+    ```
+    set_starred(owner="microsoft", name="vscode", starred=True)
+    ```
+    """
+    url = get_url("user_starred", owner=owner, repo=name)
+    headers = get_github_json_headers(
+        context.authorization.token if context.authorization and context.authorization.token else ""
+    )
+
+    async with httpx.AsyncClient() as client:
+        if starred:
+            response = await client.put(url, headers=headers)
+        else:
+            response = await client.delete(url, headers=headers)
+
+    handle_github_response(response, url)
+
+    action = "starred" if starred else "unstarred"
+    return f"Successfully {action} the repository {owner}/{name}"
+
+
+# Implements https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-stargazers
+# Example `arcade chat` usage: "list the stargazers for the ArcadeAI/arcade-ai repo"
+@tool(requires_auth=GitHub())
+async def list_stargazers(
+    context: ToolContext,
+    owner: Annotated[str, "The owner of the repository"],
+    repo: Annotated[str, "The name of the repository"],
+    limit: Annotated[
+        int | None,
+        "The maximum number of stargazers to return. "
+        "If not provided, all stargazers will be returned.",
+    ] = None,
+) -> Annotated[dict, "A dictionary containing the stargazers for the specified repository"]:
+    """List the stargazers for a GitHub repository."""
+    url = get_url("repo_stargazers", owner=owner, repo=repo)
+    headers = get_github_json_headers(
+        context.authorization.token if context.authorization and context.authorization.token else ""
+    )
+
+    if limit is None:
+        limit = 2**64 - 1
+
+    per_page = min(limit, 100)
+    page = 1
+    stargazers: list[dict] = []
+
+    async with httpx.AsyncClient() as client:
+        while len(stargazers) < limit:
+            response = await client.get(
+                url, headers=headers, params={"per_page": per_page, "page": page}
+            )
+            handle_github_response(response, url)
+
+            data = response.json()
+            if not data:
+                break
+
+            stargazers.extend([
+                {
+                    "login": stargazer.get("login"),
+                    "id": stargazer.get("id"),
+                    "node_id": stargazer.get("node_id"),
+                    "html_url": stargazer.get("html_url"),
+                }
+                for stargazer in data
+            ])
+
+            if len(data) < per_page:
+                break
+
+            page += 1
+
+    stargazers = stargazers[:limit]
+    return {"number_of_stargazers": len(stargazers), "stargazers": stargazers}

arcade_github-0.1.13/arcade_github/tools/constants.py

@@ -0,0 +1,19 @@
+# Base URL for GitHub API
+GITHUB_API_BASE_URL = "https://api.github.com"
+
+# Endpoint patterns
+ENDPOINTS = {
+    "repo": "/repos/{owner}/{repo}",
+    "org_repos": "/orgs/{org}/repos",
+    "repo_activity": "/repos/{owner}/{repo}/activity",
+    "repo_pulls_comments": "/repos/{owner}/{repo}/pulls/comments",
+    "repo_issues": "/repos/{owner}/{repo}/issues",
+    "repo_issue_comments": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
+    "repo_pulls": "/repos/{owner}/{repo}/pulls",
+    "repo_pull": "/repos/{owner}/{repo}/pulls/{pull_number}",
+    "repo_pull_commits": "/repos/{owner}/{repo}/pulls/{pull_number}/commits",
+    "repo_pull_comments": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
+    "repo_pull_comment_replies": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies",  # noqa: E501
+    "user_starred": "/user/starred/{owner}/{repo}",
+    "repo_stargazers": "/repos/{owner}/{repo}/stargazers",
+}

arcade_github-0.1.13/arcade_github/tools/issues.py

@@ -0,0 +1,158 @@
+import json
+from typing import Annotated
+
+import httpx
+from arcade_tdk import ToolContext, tool
+from arcade_tdk.auth import GitHub
+
+from arcade_github.tools.utils import (
+    get_github_json_headers,
+    get_url,
+    handle_github_response,
+    remove_none_values,
+)
+
+
+# Implements https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#create-an-issue
+# Example `arcade chat` usage:
+#   "create an issue in the <REPO> repo owned by <OWNER> titled
+#   'Found a bug' with the body 'I'm having a problem with this.'
+#   Assign it to <USER> and label it 'bug'"
+@tool(requires_auth=GitHub())
+async def create_issue(
+    context: ToolContext,
+    owner: Annotated[str, "The account owner of the repository. The name is not case sensitive."],
+    repo: Annotated[
+        str,
+        "The name of the repository without the .git extension. The name is not case sensitive.",
+    ],
+    title: Annotated[str, "The title of the issue."],
+    body: Annotated[str | None, "The contents of the issue."] = None,
+    assignees: Annotated[list[str] | None, "Logins for Users to assign to this issue."] = None,
+    milestone: Annotated[
+        int | None, "The number of the milestone to associate this issue with."
+    ] = None,
+    labels: Annotated[list[str] | None, "Labels to associate with this issue."] = None,
+    include_extra_data: Annotated[
+        bool,
+        "If true, return all the data available about the pull requests. "
+        "This is a large payload and may impact performance - use with caution.",
+    ] = False,
+) -> Annotated[
+    str,
+    "A JSON string containing the created issue's details, including id, url, title, body, state, "
+    "html_url, creation and update timestamps, user, assignees, and labels. "
+    "If include_extra_data is True, returns all available data about the issue.",
+]:
+    """
+    Create an issue in a GitHub repository.
+
+    Example:
+    ```
+    create_issue(
+        owner="octocat",
+        repo="Hello-World",
+        title="Found a bug",
+        body="I'm having a problem with this.",
+        assignees=["octocat"],
+        milestone=1,
+        labels=["bug"],
+    )
+    ```
+    """
+    url = get_url("repo_issues", owner=owner, repo=repo)
+    data = {
+        "title": title,
+        "body": body,
+        "labels": labels,
+        "milestone": milestone,
+        "assignees": assignees,
+    }
+    data = remove_none_values(data)
+    headers = get_github_json_headers(
+        context.authorization.token if context.authorization and context.authorization.token else ""
+    )
+
+    async with httpx.AsyncClient() as client:
+        response = await client.post(url, headers=headers, json=data)
+
+    handle_github_response(response, url)
+
+    issue_data = response.json()
+    if include_extra_data:
+        return json.dumps(issue_data)
+
+    important_info = {
+        "id": issue_data.get("id"),
+        "url": issue_data.get("url"),
+        "title": issue_data.get("title"),
+        "body": issue_data.get("body"),
+        "state": issue_data.get("state"),
+        "html_url": issue_data.get("html_url"),
+        "created_at": issue_data.get("created_at"),
+        "updated_at": issue_data.get("updated_at"),
+        "user": issue_data.get("user", {}).get("login"),
+        "assignees": [assignee.get("login") for assignee in issue_data.get("assignees", [])],
+        "labels": [label.get("name") for label in issue_data.get("labels", [])],
+    }
+    return json.dumps(important_info)
+
+
+# Implements https://docs.github.com/en/rest/issues/comments?apiVersion=2022-11-28#create-an-issue-comment
+# Example `arcade chat` usage:
+#   "create a comment in the vscode repo owned by microsoft for issue 1347 that says 'Me too'"
+@tool(requires_auth=GitHub())
+async def create_issue_comment(
+    context: ToolContext,
+    owner: Annotated[str, "The account owner of the repository. The name is not case sensitive."],
+    repo: Annotated[
+        str,
+        "The name of the repository without the .git extension. The name is not case sensitive.",
+    ],
+    issue_number: Annotated[int, "The number that identifies the issue."],
+    body: Annotated[str, "The contents of the comment."],
+    include_extra_data: Annotated[
+        bool,
+        "If true, return all the data available about the pull requests. "
+        "This is a large payload and may impact performance - use with caution.",
+    ] = False,
+) -> Annotated[
+    str,
+    "A JSON string containing the created comment's details, including id, url, body, user, "
+    "and creation and update timestamps. If include_extra_data is True, returns all available "
+    "data about the comment.",
+]:
+    """
+    Create a comment on an issue in a GitHub repository.
+
+    Example:
+    ```
+    create_issue_comment(owner="octocat", repo="Hello-World", issue_number=1347, body="Me too")
+    ```
+    """
+    url = get_url("repo_issue_comments", owner=owner, repo=repo, issue_number=issue_number)
+    data = {
+        "body": body,
+    }
+    headers = get_github_json_headers(
+        context.authorization.token if context.authorization and context.authorization.token else ""
+    )
+
+    async with httpx.AsyncClient() as client:
+        response = await client.post(url, headers=headers, json=data)
+
+    handle_github_response(response, url)
+
+    comment_data = response.json()
+    if include_extra_data:
+        return json.dumps(comment_data)
+
+    important_info = {
+        "id": comment_data.get("id"),
+        "url": comment_data.get("url"),
+        "body": comment_data.get("body"),
+        "user": comment_data.get("user", {}).get("login"),
+        "created_at": comment_data.get("created_at"),
+        "updated_at": comment_data.get("updated_at"),
+    }
+    return json.dumps(important_info)