feedback-hub 1.0.0__tar.gz

feedback_hub-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for OIDC trusted publisher
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build package
+        run: |
+          python -m pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

feedback_hub-1.0.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+dist/
+build/
+.pytest_cache/
+*.db

feedback_hub-1.0.0/INTEGRATING.md

@@ -0,0 +1,127 @@
+# Integrating feedback-hub
+
+## ChapterForge (wxPython)
+
+### 1. Add to requirements
+
+```
+feedback-hub>=1.0
+```
+
+### 2. Add menu item to Help menu in app.py
+
+```python
+# In the Help menu setup:
+report_item = help_menu.Append(wx.ID_ANY, "Report an Issue")
+self.Bind(wx.EVT_MENU, self.on_report_issue, report_item)
+```
+
+### 3. Add handler
+
+```python
+def on_report_issue(self, _event):
+    from pathlib import Path
+    from feedback_hub import load_schema
+    from feedback_hub.wx_dialog import FeedbackDialog
+
+    schema = load_schema(Path(__file__).parent / "schemas" / "chapterforge.json")
+    dlg = FeedbackDialog(
+        self,
+        schema=schema,
+        github_token=CHAPTERFORGE_GITHUB_TOKEN,  # bundled fine-grained PAT
+        app_version=__version__,
+    )
+    dlg.ShowModal()
+    dlg.Destroy()
+```
+
+### 4. Token setup
+
+Create a GitHub fine-grained PAT:
+- Go to GitHub Settings > Developer Settings > Personal Access Tokens > Fine-grained
+- Repository access: BITS-ACB/chapterforge only
+- Permissions: Issues = Read and Write (everything else = None)
+- Store as `CHAPTERFORGE_GITHUB_TOKEN` in a config or bundle in the app
+
+---
+
+## GLOW (Flask) - Non-breaking migration
+
+### 1. Add to requirements.txt
+
+```
+feedback-hub>=1.0
+```
+
+### 2. Replace feedback.py (one line change)
+
+```python
+# web/src/acb_large_print_web/routes/feedback.py
+# Replace entire file with:
+from feedback_hub.compat_glow import feedback_bp
+```
+
+### 3. Any code importing from support_hub still works
+
+```python
+# This still works unchanged:
+from acb_large_print_web.support_hub import create_support_issue, load_support_hub_config
+# OR directly:
+from feedback_hub.compat_glow import create_support_issue, load_support_hub_config
+```
+
+### 4. Environment variables
+
+No changes. GLOW's existing env vars still work:
+- `FEEDBACK_GITHUB_TOKEN`
+- `FEEDBACK_GITHUB_REPO`
+- `FEEDBACK_GITHUB_LABELS`
+- `FEEDBACK_GITHUB_ASSIGNEE`
+- `FEEDBACK_PASSWORD`
+- `FEEDBACK_API_TOKEN`
+
+---
+
+## QUILL (wxPython)
+
+Same pattern as ChapterForge. Replace `report_bug()` in main_frame.py:
+
+```python
+def report_bug(self) -> None:
+    from pathlib import Path
+    from feedback_hub import load_schema
+    from feedback_hub.wx_dialog import FeedbackDialog
+
+    schema = load_schema(Path(__file__).parent.parent / "schemas" / "quill.json")
+    dlg = FeedbackDialog(
+        self.frame,
+        schema=schema,
+        github_token=QUILL_GITHUB_TOKEN,
+        app_version=__version__,
+    )
+    result = dlg.ShowModal()
+    dlg.Destroy()
+    if result == wx.ID_OK:
+        self._set_status("Bug report submitted")
+```
+
+This replaces the clipboard+browser approach with direct GitHub submission.
+
+---
+
+## Token Security Notes
+
+**Fine-grained PATs with issues:write only are safe to bundle in desktop apps.**
+
+- Scope: issues:write on ONE repo only
+- Worst-case misuse: someone files extra issues in your repo
+- Cannot access code, other repos, account settings, or billing
+- Rotate annually or if compromised
+
+**Server apps (GLOW):** Token stays in `.env`, never touches clients.
+
+**Desktop apps (ChapterForge, QUILL):** Bundle a fine-grained PAT.
+```python
+# In your app's constants or settings:
+CHAPTERFORGE_GITHUB_TOKEN = "github_pat_..."  # issues:write on BITS-ACB/chapterforge only
+```

feedback_hub-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Blind Information Technology Solutions (BITS)
+
+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.

feedback_hub-1.0.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: feedback-hub
+Version: 1.0.0
+Summary: Multi-framework GitHub issue submission library - native UI per framework, centralized GitHub backend
+Project-URL: Homepage, https://github.com/community-access/feedback-hub
+Project-URL: Documentation, https://community-access.github.io/feedback-hub
+Project-URL: Repository, https://github.com/community-access/feedback-hub
+Project-URL: Issues, https://github.com/community-access/feedback-hub/issues
+Author-email: "Blind Information Technology Solutions (BITS)" <info@chapterforge.org>
+License: MIT License
+        
+        Copyright (c) 2026 Blind Information Technology Solutions (BITS)
+        
+        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.
+License-File: LICENSE
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: flask>=3.0; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Provides-Extra: flask
+Requires-Dist: flask>=3.0; extra == 'flask'
+Provides-Extra: wx
+Requires-Dist: wxpython>=4.2; extra == 'wx'
+Description-Content-Type: text/markdown
+
+# feedback-hub
+
+Multi-framework GitHub issue submission library. Native UI per framework, centralized GitHub backend.
+
+- **wxPython apps** (ChapterForge, QUILL): native dialog, direct GitHub submission
+- **Flask apps** (GLOW): web form, direct GitHub submission
+- **CLI / headless**: function call, direct GitHub submission
+
+See [INTEGRATING.md](INTEGRATING.md) for integration guides.

feedback_hub-1.0.0/README.md

@@ -0,0 +1,9 @@
+# feedback-hub
+
+Multi-framework GitHub issue submission library. Native UI per framework, centralized GitHub backend.
+
+- **wxPython apps** (ChapterForge, QUILL): native dialog, direct GitHub submission
+- **Flask apps** (GLOW): web form, direct GitHub submission
+- **CLI / headless**: function call, direct GitHub submission
+
+See [INTEGRATING.md](INTEGRATING.md) for integration guides.

feedback_hub-1.0.0/docs/PUBLISHING.md

@@ -0,0 +1,38 @@
+# Publishing feedback-hub to PyPI
+
+## Step 1 - Create a PyPI account
+
+Go to https://pypi.org/account/register/ and create an account for the BITS org (or use an existing one). Verify your email.
+
+## Step 2 - Configure a Trusted Publisher (no token needed)
+
+This is the modern approach - GitHub Actions authenticates directly with PyPI via OIDC, no API token to rotate.
+
+1. Go to https://pypi.org/manage/account/publishing/
+2. Under **Add a new pending publisher**, fill in:
+   - **PyPI project name**: `feedback-hub`
+   - **Owner**: `Community-Access`
+   - **Repository**: `feedback-hub`
+   - **Workflow name**: `publish.yml`
+   - **Environment**: `pypi`
+3. Click **Add**
+
+## Step 3 - Create the `pypi` environment in GitHub
+
+1. Go to https://github.com/Community-Access/feedback-hub/settings/environments
+2. Click **New environment**, name it `pypi`
+3. No secrets needed - the OIDC trust handles auth
+
+## Step 4 - Create a GitHub release to trigger the publish
+
+```
+gh release create v1.0.0 --repo Community-Access/feedback-hub \
+  --title "feedback-hub 1.0.0" \
+  --notes "Initial public release."
+```
+
+This triggers `publish.yml`, which builds the package and uploads it to PyPI. The package will be live at https://pypi.org/project/feedback-hub/ within a minute or two.
+
+## Step 5 - Fix ChapterForge CI
+
+Once it's on PyPI, the existing `requirements.txt` entry (`feedback-hub>=1.0`) works as-is and CI will pass.

feedback_hub-1.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "feedback-hub"
+version = "1.0.0"
+description = "Multi-framework GitHub issue submission library - native UI per framework, centralized GitHub backend"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Blind Information Technology Solutions (BITS)", email = "info@chapterforge.org" }
+]
+requires-python = ">=3.10"
+dependencies = []   # zero hard dependencies - wx and flask are optional
+
+[project.optional-dependencies]
+flask = ["flask>=3.0"]
+wx = ["wxPython>=4.2"]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov",
+    "flask>=3.0",
+    "hatch",
+]
+
+[project.urls]
+Homepage = "https://github.com/community-access/feedback-hub"
+Documentation = "https://community-access.github.io/feedback-hub"
+Repository = "https://github.com/community-access/feedback-hub"
+Issues = "https://github.com/community-access/feedback-hub/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/feedback_hub"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

feedback_hub-1.0.0/schemas/chapterforge.json

@@ -0,0 +1,67 @@
+{
+    "app": "ChapterForge",
+    "github_repo": "BITS-ACB/chapterforge",
+    "github_labels": ["bug", "needs-triage"],
+    "github_assignee": "",
+    "categories": [
+        "Bug Report",
+        "Feature Request",
+        "Accessibility Issue",
+        "Documentation",
+        "Other"
+    ],
+    "fields": [
+        {
+            "name": "summary",
+            "label": "Summary",
+            "type": "text",
+            "required": true,
+            "max_length": 120,
+            "placeholder": "Brief description of the issue"
+        },
+        {
+            "name": "message",
+            "label": "What happened",
+            "type": "textarea",
+            "required": true,
+            "max_length": 5000,
+            "placeholder": "Describe the issue in detail"
+        },
+        {
+            "name": "expected",
+            "label": "What you expected",
+            "type": "textarea",
+            "required": false,
+            "max_length": 2000
+        },
+        {
+            "name": "steps",
+            "label": "Steps to reproduce",
+            "type": "textarea",
+            "required": false,
+            "max_length": 2000,
+            "placeholder": "1. Open folder...\n2. Click Build..."
+        },
+        {
+            "name": "version",
+            "label": "ChapterForge version",
+            "type": "text",
+            "required": false,
+            "default": "__app_version__"
+        },
+        {
+            "name": "platform",
+            "label": "Operating system",
+            "type": "text",
+            "required": false,
+            "default": "__platform__"
+        },
+        {
+            "name": "screenreader",
+            "label": "Screen reader (if any)",
+            "type": "text",
+            "required": false,
+            "placeholder": "e.g. NVDA 2024.1, JAWS, or None"
+        }
+    ]
+}

feedback_hub-1.0.0/schemas/glow.json

@@ -0,0 +1,52 @@
+{
+    "app": "GLOW",
+    "github_repo": "Community-Access/support",
+    "github_labels": ["needs-triage"],
+    "github_assignee": "",
+    "categories": [
+        "Bug Report",
+        "Feature Request",
+        "Accessibility Issue",
+        "Document Conversion",
+        "Braille",
+        "Documentation",
+        "Other"
+    ],
+    "fields": [
+        {
+            "name": "summary",
+            "label": "Summary",
+            "type": "text",
+            "required": true,
+            "max_length": 120
+        },
+        {
+            "name": "message",
+            "label": "Details",
+            "type": "textarea",
+            "required": true,
+            "max_length": 5000
+        },
+        {
+            "name": "task",
+            "label": "What were you trying to do",
+            "type": "text",
+            "required": false,
+            "max_length": 240
+        },
+        {
+            "name": "version",
+            "label": "GLOW version",
+            "type": "text",
+            "required": false,
+            "default": "__app_version__"
+        },
+        {
+            "name": "platform",
+            "label": "Browser / OS",
+            "type": "text",
+            "required": false,
+            "default": "__platform__"
+        }
+    ]
+}

feedback_hub-1.0.0/schemas/quill.json

@@ -0,0 +1,65 @@
+{
+    "app": "Quill",
+    "github_repo": "Community-Access/quill",
+    "github_labels": ["bug", "needs-triage"],
+    "github_assignee": "",
+    "categories": [
+        "Bug Report",
+        "Feature Request",
+        "Accessibility Issue",
+        "Documentation",
+        "Other"
+    ],
+    "fields": [
+        {
+            "name": "summary",
+            "label": "Summary",
+            "type": "text",
+            "required": true,
+            "max_length": 120,
+            "default": "Bug report"
+        },
+        {
+            "name": "message",
+            "label": "What happened",
+            "type": "textarea",
+            "required": true,
+            "max_length": 5000
+        },
+        {
+            "name": "expected",
+            "label": "What you expected",
+            "type": "textarea",
+            "required": false,
+            "max_length": 2000
+        },
+        {
+            "name": "steps",
+            "label": "Steps to reproduce",
+            "type": "textarea",
+            "required": false,
+            "max_length": 2000
+        },
+        {
+            "name": "version",
+            "label": "Quill version",
+            "type": "text",
+            "required": false,
+            "default": "__app_version__"
+        },
+        {
+            "name": "platform",
+            "label": "Operating system",
+            "type": "text",
+            "required": false,
+            "default": "__platform__"
+        },
+        {
+            "name": "screenreader",
+            "label": "Screen reader (if any)",
+            "type": "text",
+            "required": false,
+            "placeholder": "e.g. NVDA 2024.1, JAWS, or None"
+        }
+    ]
+}

feedback_hub-1.0.0/src/feedback_hub/__init__.py

@@ -0,0 +1,117 @@
+"""feedback-hub - Multi-framework GitHub issue submission library.
+
+Each app uses its native UI; all submit directly to GitHub Issues.
+
+Quick start (wxPython)::
+
+    from feedback_hub import load_schema
+    from feedback_hub.wx_dialog import FeedbackDialog
+
+    schema = load_schema({"app": "MyApp", "github_repo": "org/repo", "fields": [...]})
+    dlg = FeedbackDialog(parent, schema=schema, github_token=TOKEN)
+    dlg.ShowModal()
+    dlg.Destroy()
+
+Quick start (Flask)::
+
+    from feedback_hub.flask_blueprint import make_blueprint
+
+    feedback_bp = make_blueprint(app_name="MyApp", github_repo="org/repo")
+    app.register_blueprint(feedback_bp, url_prefix="/feedback")
+
+Quick start (headless / CLI)::
+
+    from feedback_hub import submit
+
+    issue_url, error = submit(
+        app="MyApp",
+        github_repo="org/repo",
+        github_token=TOKEN,
+        summary="Something is broken",
+        message="Details here",
+        category="Bug Report",
+    )
+"""
+from feedback_hub._github import GitHubConfig, resolve_token
+from feedback_hub._schema import AppSchema, FieldSchema, build_entry, load_schema
+from feedback_hub._storage import list_all, save
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "AppSchema",
+    "FieldSchema",
+    "GitHubConfig",
+    "build_entry",
+    "list_all",
+    "load_schema",
+    "resolve_token",
+    "save",
+    "submit",
+]
+
+
+def submit(
+    *,
+    app: str,
+    github_repo: str,
+    github_token: str = "",
+    summary: str = "",
+    message: str,
+    category: str = "feedback",
+    name: str = "",
+    email: str = "",
+    app_version: str = "",
+    github_labels: list[str] | None = None,
+    github_assignee: str = "",
+    metadata: dict | None = None,
+    db_path=None,
+) -> tuple:
+    """Headless submission -- no UI required.
+
+    Returns ``(issue_url, error_message)``.
+    """
+    from datetime import UTC, datetime
+    from pathlib import Path
+
+    from feedback_hub._github import create_issue
+    from feedback_hub._storage import save as _save, update_github_sync
+
+    token = resolve_token(github_token)
+    entry = {
+        "app": app,
+        "version": app_version,
+        "platform": "",
+        "category": category,
+        "name": name,
+        "email": email,
+        "summary": summary,
+        "message": message,
+        "metadata": metadata,
+        "timestamp": datetime.now(UTC).isoformat(),
+    }
+
+    _db = db_path or Path.home() / ".local" / "share" / "feedback-hub" / "feedback.db"
+    try:
+        row_id = _save(entry, Path(_db))
+    except Exception:
+        row_id = None
+
+    if not token:
+        return None, "GitHub token not configured"
+
+    cfg = GitHubConfig(
+        token=token,
+        repo=github_repo,
+        assignee=github_assignee,
+        labels=github_labels or ["needs-triage"],
+    )
+    number, url, error = create_issue(entry, cfg)
+
+    if row_id is not None:
+        try:
+            update_github_sync(row_id, issue_number=number, issue_url=url, error=error, db_path=Path(_db))
+        except Exception:
+            pass
+
+    return url, error