buganize 0.2.2__tar.gz

buganize-0.2.2/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: buganize
+Version: 0.2.2
+Summary: Python client for the Chromium Issue Tracker
+Author: Ritchie Mwewa
+Author-email: Ritchie Mwewa <hi@rly0nheart.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Bug Tracking
+Classifier: Framework :: AsyncIO
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pandas>=3.0.1
+Requires-Dist: rich>=14.3.3
+Requires-Dist: update-checker>=0.18.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# Buganize
+
+Python client for the Chromium Issue Tracker.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage as a library](#usage-as-a-library)
+    - [Search issues](#search-issues)
+    - [Get a single issue](#get-a-single-issue)
+    - [Batch get issues](#batch-get-issues)
+    - [Get comments](#get-comments)
+    - [Get full updates](#get-full-updates)
+- [CLI usage](#cli-usage)
+    - [Search](#search)
+    - [Issue](#issue)
+    - [Issues (batch)](#issues-batch)
+    - [Comments](#comments)
+    - [Extra fields](#extra-fields)
+    - [Export](#export)
+    - [Debug logging](#debug-logging)
+    - [Timeout](#timeout)
+- [How it works](#how-it-works)
+- [Limitations](#limitations)
+
+## Installation
+
+```shell
+pip install buganize
+```
+
+> [!Tip]
+> Running `pip install buganise` will also install the package
+
+## Usage as a library
+
+### Search issues
+
+```python
+from buganize import Buganize
+
+
+async def search():
+    async with Buganize() as client:
+        result = await client.search("status:open component:Blink", page_size=10)
+
+        print(f"{result.total_count} total matches")
+        for issue in result.issues:
+            print(f"#{issue.id} [{issue.status.name}] {issue.title}")
+
+        # Pagination
+        if result.has_more:
+            page2 = await client.next_page(result)
+            for issue in page2.issues:
+                print(f"#{issue.id} [{issue.status.name}] {issue.title}")
+```
+
+### Get a single issue
+
+```python
+async def get_issue():
+    async with Buganize() as client:
+        issue = await client.issue(40060244)
+
+        print(issue.title)
+        print(issue.url)  # https://issues.chromium.org/issues/40060244
+        print(issue.status.name)  # e.g. "FIXED"
+        print(issue.priority.name)  # e.g. "P2"
+        print(issue.os)  # e.g. ["Linux", "Mac", "Windows"]
+        print(issue.cve)  # e.g. ["CVE-2024-1234"]
+```
+
+### Batch get issues
+
+```python
+async def batch_get():
+    async with Buganize() as client:
+        issues = await client.issues([40060244, 485912774, 486077869])
+
+        for issue in issues:
+            print(f"#{issue.id} - {issue.title}")
+```
+
+### Get comments
+
+```python
+async def get_comments():
+    async with Buganize() as client:
+        comments = await client.comments(486077869)
+
+        for comment in comments:
+            print(f"#{comment.comment_number} by {comment.author}")
+            print(comment.body)
+```
+
+### Get full updates
+
+Updates include both comments and field changes (status changes, priority changes, etc.):
+
+```python
+async def get_updates():
+    async with Buganize() as client:
+        result = await client.issue_updates(486077869)
+
+        print(f"{result.total_count} total updates")
+
+        # Just the comments, in chronological order
+        for comment in result.comments:
+            print(f"#{comment.comment_number}: {comment.body[:80]}")
+
+        # All updates (newest first), including field changes
+        for update in result.updates:
+            if update.field_changes:
+                changed = ", ".join(fc.field for fc in update.field_changes)
+                print(f"  Fields changed: {changed}")
+            if update.comment:
+                print(f"  Comment: {update.comment.body[:80]}")
+```
+
+## CLI usage
+
+Run with `python -m buganize <command>` or just `buganize <command>`.
+
+### Search
+
+```bash
+# Search for open issues
+buganize search "status:open"
+
+# Combined filters
+buganize search "status:open component:Blink"
+
+# Results per page (choices: 25, 50, 100, 250)
+buganize search "type:bug" -n 100
+
+# Fetch a total of 200 results, paginating as needed
+buganize search "status:open" -l 200
+```
+
+### Issue
+
+```bash
+buganize issue 486077869
+```
+
+### Issues (batch)
+
+```bash
+buganize issues 40060244 485912774 486077869
+```
+
+### Comments
+
+```bash
+buganize comments 486077869
+```
+
+### Extra fields
+
+By default, the table output only shows ID, Status, Priority, and Title. You can show additional columns:
+
+```bash
+# Show specific extra fields
+buganize search "status:open" -f owner os milestone
+
+# Show all available fields
+buganize search "status:open" -F
+
+# Works with issue and issues too
+buganize issue 486077869 --fields cve tags labels
+buganize issue 486077869 --all-fields
+```
+
+Available extra field names: `owner`, `reporter`, `verifier`, `type`, `component`, `tags`, `ancestor_tags`, `labels`,
+`os`, `milestone`, `ccs`, `hotlists`, `blocking`, `cve`, `cwe`, `build`, `introduced_in`, `merge`, `merge_request`,
+`release_block`, `notice`, `flaky_test`, `est_days`, `next_action`, `vrp_reward`, `irm_link`, `sec_release`, `fixed_by`,
+`created`, `modified`, `verified`, `comments`, `stars`, `last_modifier`.
+
+### Export
+
+All commands support `-e/--export` for exporting to CSV, JSON, or HTML. You can specify multiple formats at once:
+
+```bash
+buganize -e csv search "status:open" -n 50
+buganize -e json issue 486077869
+buganize -e html comments 486077869
+
+# Multiple formats in one command
+buganize -e csv json search "status:open"
+```
+
+### Debug logging
+
+Use `-d/--debug` to see HTTP request/response details:
+
+```bash
+buganize --debug search "status:open"
+```
+
+### Timeout
+
+Use `-t/--timeout` to set the HTTP request timeout in seconds (default: 30):
+
+```bash
+buganize -t 60 search "status:open"
+```
+
+> [!Tip]
+> British English spelling `buganise` will also work.
+
+## How it works
+
+The Chromium issue tracker at `issues.chromium.org` doesn't have a documented public API. But the web frontend talks to
+a set of POST endpoints under `https://issues.chromium.org/action/` using JSON arrays as request/response bodies. This
+library speaks that same protocol.
+
+Every response from the API starts with `)]}'\n` (an anti-XSSI prefix) followed by a JSON array. Issue data comes back
+as 48-element positional arrays, no keys, just indexes. The parser maps those indexes to fields on the `Issue`
+dataclass. Custom fields (things like OS, milestone, CVE, component tags) are embedded inside the issue array at a
+specific offset and have their own internal structure.
+
+No cookies or tokens are needed for reading public issues. The only headers required are `Content-Type`, `Origin`,
+`Referer`, and a browser-like `User-Agent`.
+
+## Limitations
+
+- This uses an undocumented API. It could break if Google changes the response format.
+- Only works with public issues. Private/restricted issues need authentication cookies that this client doesn't handle.
+- The parser is entirely index-based. If the API adds or removes fields from the arrays, the parsing will silently
+  return wrong data.
+- Pagination for updates (comments) is not fully wired up, currently fetches the first page only.
+- The batch endpoint may not return issues in the same order as the input IDs.

buganize-0.2.2/README.md

@@ -0,0 +1,232 @@
+# Buganize
+
+Python client for the Chromium Issue Tracker.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage as a library](#usage-as-a-library)
+    - [Search issues](#search-issues)
+    - [Get a single issue](#get-a-single-issue)
+    - [Batch get issues](#batch-get-issues)
+    - [Get comments](#get-comments)
+    - [Get full updates](#get-full-updates)
+- [CLI usage](#cli-usage)
+    - [Search](#search)
+    - [Issue](#issue)
+    - [Issues (batch)](#issues-batch)
+    - [Comments](#comments)
+    - [Extra fields](#extra-fields)
+    - [Export](#export)
+    - [Debug logging](#debug-logging)
+    - [Timeout](#timeout)
+- [How it works](#how-it-works)
+- [Limitations](#limitations)
+
+## Installation
+
+```shell
+pip install buganize
+```
+
+> [!Tip]
+> Running `pip install buganise` will also install the package
+
+## Usage as a library
+
+### Search issues
+
+```python
+from buganize import Buganize
+
+
+async def search():
+    async with Buganize() as client:
+        result = await client.search("status:open component:Blink", page_size=10)
+
+        print(f"{result.total_count} total matches")
+        for issue in result.issues:
+            print(f"#{issue.id} [{issue.status.name}] {issue.title}")
+
+        # Pagination
+        if result.has_more:
+            page2 = await client.next_page(result)
+            for issue in page2.issues:
+                print(f"#{issue.id} [{issue.status.name}] {issue.title}")
+```
+
+### Get a single issue
+
+```python
+async def get_issue():
+    async with Buganize() as client:
+        issue = await client.issue(40060244)
+
+        print(issue.title)
+        print(issue.url)  # https://issues.chromium.org/issues/40060244
+        print(issue.status.name)  # e.g. "FIXED"
+        print(issue.priority.name)  # e.g. "P2"
+        print(issue.os)  # e.g. ["Linux", "Mac", "Windows"]
+        print(issue.cve)  # e.g. ["CVE-2024-1234"]
+```
+
+### Batch get issues
+
+```python
+async def batch_get():
+    async with Buganize() as client:
+        issues = await client.issues([40060244, 485912774, 486077869])
+
+        for issue in issues:
+            print(f"#{issue.id} - {issue.title}")
+```
+
+### Get comments
+
+```python
+async def get_comments():
+    async with Buganize() as client:
+        comments = await client.comments(486077869)
+
+        for comment in comments:
+            print(f"#{comment.comment_number} by {comment.author}")
+            print(comment.body)
+```
+
+### Get full updates
+
+Updates include both comments and field changes (status changes, priority changes, etc.):
+
+```python
+async def get_updates():
+    async with Buganize() as client:
+        result = await client.issue_updates(486077869)
+
+        print(f"{result.total_count} total updates")
+
+        # Just the comments, in chronological order
+        for comment in result.comments:
+            print(f"#{comment.comment_number}: {comment.body[:80]}")
+
+        # All updates (newest first), including field changes
+        for update in result.updates:
+            if update.field_changes:
+                changed = ", ".join(fc.field for fc in update.field_changes)
+                print(f"  Fields changed: {changed}")
+            if update.comment:
+                print(f"  Comment: {update.comment.body[:80]}")
+```
+
+## CLI usage
+
+Run with `python -m buganize <command>` or just `buganize <command>`.
+
+### Search
+
+```bash
+# Search for open issues
+buganize search "status:open"
+
+# Combined filters
+buganize search "status:open component:Blink"
+
+# Results per page (choices: 25, 50, 100, 250)
+buganize search "type:bug" -n 100
+
+# Fetch a total of 200 results, paginating as needed
+buganize search "status:open" -l 200
+```
+
+### Issue
+
+```bash
+buganize issue 486077869
+```
+
+### Issues (batch)
+
+```bash
+buganize issues 40060244 485912774 486077869
+```
+
+### Comments
+
+```bash
+buganize comments 486077869
+```
+
+### Extra fields
+
+By default, the table output only shows ID, Status, Priority, and Title. You can show additional columns:
+
+```bash
+# Show specific extra fields
+buganize search "status:open" -f owner os milestone
+
+# Show all available fields
+buganize search "status:open" -F
+
+# Works with issue and issues too
+buganize issue 486077869 --fields cve tags labels
+buganize issue 486077869 --all-fields
+```
+
+Available extra field names: `owner`, `reporter`, `verifier`, `type`, `component`, `tags`, `ancestor_tags`, `labels`,
+`os`, `milestone`, `ccs`, `hotlists`, `blocking`, `cve`, `cwe`, `build`, `introduced_in`, `merge`, `merge_request`,
+`release_block`, `notice`, `flaky_test`, `est_days`, `next_action`, `vrp_reward`, `irm_link`, `sec_release`, `fixed_by`,
+`created`, `modified`, `verified`, `comments`, `stars`, `last_modifier`.
+
+### Export
+
+All commands support `-e/--export` for exporting to CSV, JSON, or HTML. You can specify multiple formats at once:
+
+```bash
+buganize -e csv search "status:open" -n 50
+buganize -e json issue 486077869
+buganize -e html comments 486077869
+
+# Multiple formats in one command
+buganize -e csv json search "status:open"
+```
+
+### Debug logging
+
+Use `-d/--debug` to see HTTP request/response details:
+
+```bash
+buganize --debug search "status:open"
+```
+
+### Timeout
+
+Use `-t/--timeout` to set the HTTP request timeout in seconds (default: 30):
+
+```bash
+buganize -t 60 search "status:open"
+```
+
+> [!Tip]
+> British English spelling `buganise` will also work.
+
+## How it works
+
+The Chromium issue tracker at `issues.chromium.org` doesn't have a documented public API. But the web frontend talks to
+a set of POST endpoints under `https://issues.chromium.org/action/` using JSON arrays as request/response bodies. This
+library speaks that same protocol.
+
+Every response from the API starts with `)]}'\n` (an anti-XSSI prefix) followed by a JSON array. Issue data comes back
+as 48-element positional arrays, no keys, just indexes. The parser maps those indexes to fields on the `Issue`
+dataclass. Custom fields (things like OS, milestone, CVE, component tags) are embedded inside the issue array at a
+specific offset and have their own internal structure.
+
+No cookies or tokens are needed for reading public issues. The only headers required are `Content-Type`, `Origin`,
+`Referer`, and a browser-like `User-Agent`.
+
+## Limitations
+
+- This uses an undocumented API. It could break if Google changes the response format.
+- Only works with public issues. Private/restricted issues need authentication cookies that this client doesn't handle.
+- The parser is entirely index-based. If the API adds or removes fields from the arrays, the parsing will silently
+  return wrong data.
+- Pagination for updates (comments) is not fully wired up, currently fetches the first page only.
+- The batch endpoint may not return issues in the same order as the input IDs.

buganize-0.2.2/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "buganize"
+version = "0.2.2"
+description = "Python client for the Chromium Issue Tracker"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "Ritchie Mwewa", email = "hi@rly0nheart.com" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Bug Tracking",
+    "Framework :: AsyncIO",
+]
+dependencies = [
+    "httpx>=0.28.1",
+    "pandas>=3.0.1",
+    "rich>=14.3.3",
+    "update-checker>=0.18.0",
+]
+
+[project.scripts]
+buganize = "buganize.cli.main:start"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.3.0",
+    "black>=26.1.0"
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[build-system]
+requires = ["uv_build>=0.8.3,<0.9.0"]
+build-backend = "uv_build"

buganize-0.2.2/src/buganize/__init__.py

@@ -0,0 +1,33 @@
+from buganize.api.client import Buganize
+from buganize.api.models import (
+    CUSTOM_FIELD_IDS,
+    Comment,
+    CustomFieldValue,
+    FieldChange,
+    Issue,
+    IssueType,
+    IssueUpdate,
+    IssueUpdatesResult,
+    Priority,
+    SearchResult,
+    Status,
+)
+from buganize.cli.output import EXTRA_FIELDS, export, to_dataframe
+
+__all__ = [
+    "CUSTOM_FIELD_IDS",
+    "Buganize",
+    "Comment",
+    "CustomFieldValue",
+    "EXTRA_FIELDS",
+    "FieldChange",
+    "Issue",
+    "IssueType",
+    "IssueUpdate",
+    "IssueUpdatesResult",
+    "Priority",
+    "SearchResult",
+    "Status",
+    "export",
+    "to_dataframe",
+]

buganize-0.2.2/src/buganize/__main__.py

@@ -0,0 +1,3 @@
+from buganize.cli.main import start
+
+start()

buganize-0.2.2/src/buganize/api/__init__.py

@@ -0,0 +1,3 @@
+from . import client, models, parser
+
+__all__ = ["client", "models", "parser"]