awreport 0.1.0__tar.gz

awreport-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

awreport-0.1.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: awreport
+Version: 0.1.0
+Summary: File structured bug reports and feature requests to GitHub, with automatic redaction and deduplication
+Author-email: AitherOS Contributors <dev@aitherium.com>
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# awreport — Aither World Report
+
+File structured bug reports and feature requests to GitHub, with automatic redaction of secrets and deduplication.
+
+A standalone Python package for any application to file issues to GitHub:
+- ✅ Works standalone — just a GitHub token and repo
+- ✅ Automatic secret redaction (API keys, tokens, home paths, etc.)
+- ✅ Duplicate detection with fingerprinting
+- ✅ Supports bug reports, feature requests, and general feedback
+- ✅ Zero monorepo dependencies — pure Python + requests
+- ✅ Fully typed, comprehensive tests
+
+## Installation
+
+```bash
+pip install awreport
+```
+
+Or install from source:
+
+```bash
+git clone <repo-url>
+cd awreport
+pip install -e .
+```
+
+## Quick Start
+
+### Via Python API
+
+```python
+from awreport import ReportClient
+
+# Initialize client with your GitHub token and target repo
+client = ReportClient(
+    token="ghp_...",
+    repo="owner/repo"
+)
+
+# Verify access
+result = client.verify_access()
+if result.status.value != "success":
+    print(f"Error: {result.message}")
+    exit(1)
+
+# Report a bug
+result = client.report_bug(
+    title="Login fails with special characters",
+    description="When using email+tag@example.com, login is rejected",
+    environment={"os": "Linux", "python": "3.10"},
+    stack_trace="Traceback...",
+)
+
+if result.is_success():
+    print(f"✓ Issue #{result.issue_number} filed")
+    print(f"  {result.issue_url}")
+elif result.was_duplicate:
+    print(f"✓ Duplicate of issue #{result.duplicate_issue_number}")
+else:
+    print(f"✗ Error: {result.message}")
+    if result.error_details:
+        print(f"  {result.error_details}")
+
+# Report a feature request
+feature_result = client.report_feature(
+    title="Add dark mode",
+    description="Users have requested a dark mode toggle"
+)
+
+# Send general feedback
+feedback_result = client.report_feedback(
+    message="Great app! Love the new dashboard.",
+    tags=["praise", "dashboard"]
+)
+```
+
+### Via CLI
+
+```bash
+# Verify access
+awreport --token ghp_... --repo owner/repo verify
+
+# Report a bug (with optional stack trace file)
+awreport --token ghp_... --repo owner/repo bug \
+  "Login fails with special characters" \
+  "Cannot log in with email+tag@example.com" \
+  --env-json '{"os":"Linux","python":"3.10"}' \
+  --stack-trace-file /path/to/traceback.txt
+
+# Report a feature request
+awreport --token ghp_... --repo owner/repo feature \
+  "Add dark mode" \
+  "Users want a dark mode toggle"
+
+# Send feedback
+awreport --token ghp_... --repo owner/repo feedback \
+  "Great app! Love the UI." \
+  --tags praise,ui
+```
+
+Or use environment variables:
+
+```bash
+export GITHUB_TOKEN="ghp_..."
+export GITHUB_REPO="owner/repo"
+
+awreport verify
+awreport bug "Title" "Description"
+```
+
+## Secret Redaction
+
+All feedback is automatically redacted before filing to GitHub. Secrets detected and redacted include:
+
+- **API Keys**: Anthropic (`sk-ant-*`), OpenAI (`sk-*`), AWS (`AKIA*`)
+- **Tokens**: GitHub PAT (`ghp_*`), Slack (`xoxb-*`, `xoxp-*`), Bearer tokens
+- **Paths**: Home directory paths (`/home/user/`, `C:\Users\...`)
+- **High-entropy strings**: Base64-like tokens >40 characters
+- **Other patterns**: `api_key=`, `password=`, etc.
+
+Redaction is **fail-closed**: if redaction cannot complete safely, the report is NOT filed:
+
+```python
+from awreport import RedactionError, ReportClient
+
+client = ReportClient(token="...", repo="...")
+
+try:
+    result = client.report_bug(title, description, environment, stack_trace)
+except RedactionError:
+    print("Could not safely redact sensitive data. Report not filed.")
+    # Application should log this and possibly alert a human
+```
+
+## Duplicate Detection
+
+Feedback is fingerprinted and compared against existing issues:
+
+1. **Title normalization**: lowercase, strip, remove extra whitespace
+2. **Stack trace hashing**: last 5 frames, SHA-256 hash (first 16 chars)
+3. **Existing issue search**: GitHub API search with filters
+4. **Match logic**:
+   - Bugs: must match title + stack trace hash (strong match)
+   - Features/feedback: title match alone is sufficient
+
+If a duplicate is found:
+- The existing issue number is returned in `ReportResult.duplicate_issue_number`
+- A comment is added to the existing issue with new environment info
+- Status is `ReportStatus.DUPLICATE` but `is_success()` still returns `True`
+
+```python
+result = client.report_bug(title, description)
+if result.was_duplicate:
+    print(f"Already reported as issue #{result.duplicate_issue_number}")
+```
+
+## Return Values
+
+Every report returns a `ReportResult` with:
+
+- `status`: `SUCCESS`, `DUPLICATE`, `ERROR`, or `REDACTION_FAILED`
+- `message`: Human-readable status message
+- `issue_number`: GitHub issue number (if successful)
+- `issue_url`: GitHub issue URL (if successful)
+- `was_duplicate`: `True` if a duplicate was found
+- `duplicate_issue_number`: Number of duplicate issue (if applicable)
+- `error_details`: Error details (if `status == ERROR`)
+
+```python
+result = client.report_bug(...)
+
+if result.is_success():
+    # SUCCESS or DUPLICATE
+    print(f"Issue: {result.issue_url}")
+else:
+    # ERROR or REDACTION_FAILED
+    print(f"Failed: {result.message}")
+    print(f"Details: {result.error_details}")
+```
+
+## Type Safety
+
+All public functions are fully typed for IDE autocomplete:
+
+```python
+from awreport import ReportClient, ReportResult, FeedbackKind
+
+def handle_bug(client: ReportClient, title: str, desc: str) -> ReportResult:
+    return client.report_bug(title, desc)
+
+# IDE provides full autocomplete and type checking
+```
+
+## Testing
+
+Run tests:
+
+```bash
+pip install -e ".[dev]"
+pytest tests/
+```
+
+Tests include:
+- **Redaction**: secrets are redacted, normal text is preserved
+- **GitHub integration**: API calls are mocked, various scenarios tested
+- **Deduplication**: fingerprints match similar issues, exact duplicates detected
+- **CLI**: argument parsing, error handling
+
+All tests use **positive assertions** — they verify that successful operations produce the expected output:
+
+```python
+def test_report_bug_creates_issue():
+    """Test report_bug creates an issue."""
+    result = client.report_bug(title, description)
+    assert result.status == ReportStatus.SUCCESS
+    assert result.issue_number == 42
+    assert result.issue_url is not None
+```
+
+## Design Principles
+
+1. **Standalone**: No monorepo imports, no internal dependencies. Just GitHub token + repo.
+2. **Fail-closed**: If redaction fails, do NOT send. If verification fails, report it.
+3. **Fully typed**: Every public function has type hints. Mypy-clean.
+4. **Comprehensive redaction**: Better to over-redact than under-redact.
+5. **Dedup prevents spam**: Same issue = one thread with new comments, not N issues.
+6. **Graceful degradation**: Search failure doesn't block issue creation. Comment failure doesn't block duplicate detection.
+
+## Environment Variables
+
+- `GITHUB_TOKEN`: GitHub personal access token (required if `--token` not provided)
+- `GITHUB_REPO`: Repository in format `owner/repo` (required if `--repo` not provided)
+
+## Development
+
+Install dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run linting:
+
+```bash
+ruff check awreport/ tests/
+mypy awreport/
+```
+
+Format code:
+
+```bash
+black awreport/ tests/
+```
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Contributions welcome! Please:
+1. Write tests for new functionality
+2. Run `pytest` and linting before submitting
+3. Keep redaction comprehensive — err on the side of over-redacting
+4. Maintain zero monorepo dependencies