symeraseme 0.1.4__tar.gz

symeraseme-0.1.4/.env.example

@@ -0,0 +1,75 @@
+# Symaira EraseMe Environment Configuration
+# Copy this file to .env and fill in your values.
+# Symaira EraseMe reads environment variables for API keys, data paths, and consent.
+
+# ──────────────────────────────────────────────────────────────
+# LLM Provider Configuration (required for AI-powered triage)
+# ──────────────────────────────────────────────────────────────
+
+# LLM provider: anthropic, openai, or ollama (default: anthropic)
+SYMERASEME_LLM_PROVIDER=anthropic
+
+# Model name (provider-specific; omit to use provider default)
+# Anthropic: claude-3-5-sonnet-latest, claude-3-5-haiku-latest, claude-3-opus-latest
+# OpenAI: gpt-4o, gpt-4o-mini, gpt-4-turbo
+# Ollama: llama3.1, mistral, codellama
+# SYMERASEME_LLM_MODEL=claude-3-5-sonnet-latest
+
+# Provider-specific API keys
+ANTHROPIC_API_KEY=sk-ant-api03-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+# Ollama host (only needed when provider=ollama; default: http://localhost:11434)
+OLLAMA_HOST=http://localhost:11434
+
+# ──────────────────────────────────────────────────────────────
+# CAPTCHA Solving Services (optional — choose one)
+# ──────────────────────────────────────────────────────────────
+
+# CapSolver API key for automated CAPTCHA solving
+CAPSOLVER_API_KEY=CAP-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+# 2Captcha API key for automated CAPTCHA solving
+TWOCAPTCHA_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+# ──────────────────────────────────────────────────────────────
+# Data Paths (optional — defaults to ~/.local/share/symeraseme)
+# ──────────────────────────────────────────────────────────────
+
+# Directory for the SQLite database and event store
+SYMERASEME_DB_DIR=~/.local/share/symeraseme
+
+# Directory for general application data
+SYMERASEME_DATA_DIR=~/.local/share/symeraseme
+
+# Path to the encrypted identity profile file
+SYMERASEME_IDENTITY_PATH=~/.local/share/symeraseme/identity.encrypted
+
+# Path to the Python virtual environment used by the scheduler
+SYMERASEME_VENV=~/.local/share/symeraseme/venv
+
+# ──────────────────────────────────────────────────────────────
+# Consent & Security
+# ──────────────────────────────────────────────────────────────
+
+# Consent token for destructive operations (generated by `symeraseme consent`)
+SYMERASEME_CONSENT=
+
+# ──────────────────────────────────────────────────────────────
+# SMTP (optional — for direct batch email sending)
+# ──────────────────────────────────────────────────────────────
+
+# Email backend selection (default: smtp)
+#   smtp    — direct SMTP connection via stdlib smtplib (no external CLI)
+#   himalaya — Himalaya CLI subprocess (requires `cargo install himalaya`)
+SYMERASEME_EMAIL_BACKEND=smtp
+
+# SMTP connection used by the async batch email path
+# (avoids spawning a Himalaya CLI subprocess per message)
+SYMERASEME_SMTP_HOST=localhost
+SYMERASEME_SMTP_PORT=587
+SYMERASEME_SMTP_USER=
+SYMERASEME_SMTP_PASSWORD=
+SYMERASEME_SMTP_FROM=
+# Set to 0 to disable STARTTLS (e.g. for local test servers)
+SYMERASEME_SMTP_TLS=1

symeraseme-0.1.4/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @danieljustus

symeraseme-0.1.4/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+daniel@ohmyopen.com.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

symeraseme-0.1.4/.github/ISSUE_TEMPLATE/broker.yml

@@ -0,0 +1,154 @@
+name: Add / Update Data Broker
+description: Submit a new data broker or update an existing one in the registry
+labels: ["broker", "registry"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Adding a Broker to the Registry
+
+        Thank you for contributing! Each broker entry is a YAML file in
+        `registry/brokers/<region>/`. A merged entry means Symaira EraseMe can
+        automatically file opt-out requests on behalf of users.
+
+        **Quick guide:**
+        - `us/` → US brokers (CCPA / CPRA)
+        - `eu/` → EU brokers (GDPR)
+        - `uk/` → UK brokers (UK GDPR)
+
+        See `registry/brokers/eu/_example.yaml` for the full reference format,
+        and `registry/schemas/broker.schema.json` for the schema.
+
+  - type: input
+    id: broker_name
+    attributes:
+      label: Broker Name
+      description: Legal name of the data broker.
+      placeholder: "e.g. Radaris LLC"
+    validations:
+      required: true
+
+  - type: input
+    id: broker_website
+    attributes:
+      label: Website
+      description: Broker homepage URL.
+      placeholder: "https://example.com"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: region
+    attributes:
+      label: Region / Jurisdiction
+      description: Where does this broker primarily operate?
+      options:
+        - US (CCPA / CPRA)
+        - EU (GDPR)
+        - UK (UK GDPR)
+        - Other (describe in notes)
+      multiple: false
+    validations:
+      required: true
+
+  - type: dropdown
+    id: category
+    attributes:
+      label: Category
+      options:
+        - people-search
+        - background-check
+        - marketing
+        - credit
+        - analytics
+        - social-media
+        - other
+      multiple: false
+    validations:
+      required: true
+
+  - type: dropdown
+    id: opt_out_type
+    attributes:
+      label: Opt-Out Method
+      description: How do users submit removal requests?
+      options:
+        - Web form (automated)
+        - Email request
+        - Both web form and email
+        - Unknown / needs research
+      multiple: false
+    validations:
+      required: true
+
+  - type: input
+    id: opt_out_url
+    attributes:
+      label: Opt-Out URL or Email
+      description: Direct link to the opt-out page, or the privacy/deletion email address.
+      placeholder: "https://example.com/optout  or  privacy@example.com"
+
+  - type: textarea
+    id: form_fields
+    attributes:
+      label: Required Form Fields
+      description: |
+        What information does the opt-out form or email request require?
+        Check all that apply (or describe freeform).
+      placeholder: |
+        - [ ] First name / Last name
+        - [ ] Email address
+        - [ ] Postal address
+        - [ ] Date of birth
+        - [ ] State / Country
+        - [ ] Social Security Number (last 4)
+        - [ ] CAPTCHA present (type: reCAPTCHA v2 / v3 / hCaptcha)
+
+  - type: textarea
+    id: confirmation_keywords
+    attributes:
+      label: Confirmation / Acknowledgement Keywords
+      description: |
+        What text appears on screen or in a confirmation email after
+        a successful opt-out submission? These are used for automated triage.
+      placeholder: |
+        e.g. "Your request has been submitted", "opt-out confirmed", "removal request received"
+
+  - type: textarea
+    id: captcha_sitekey
+    attributes:
+      label: CAPTCHA Site Key (if applicable)
+      description: |
+        If the form has a reCAPTCHA or hCaptcha, provide the `data-sitekey`
+        attribute value from the page's HTML source. This is needed for
+        automated solving.
+      placeholder: "6Lc...XXXX  (found in the page's HTML as data-sitekey=)"
+
+  - type: textarea
+    id: notes
+    attributes:
+      label: Additional Notes
+      description: |
+        Anything else that would help implement or verify this broker entry:
+        required identity documents, quirks, regional variations, known issues, etc.
+
+  - type: textarea
+    id: yaml_draft
+    attributes:
+      label: Draft YAML (optional but appreciated)
+      description: |
+        If you're comfortable with the format, paste a draft YAML entry here.
+        Look at `registry/brokers/eu/_example.yaml` for the reference.
+      render: yaml
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      options:
+        - label: I have searched existing broker files and this broker is not yet listed.
+          required: true
+        - label: I have verified the opt-out URL / email is currently reachable.
+          required: true
+        - label: I am not including any personal data (credentials, API keys) in this submission.
+          required: true

symeraseme-0.1.4/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,74 @@
+name: Bug Report
+description: Report a bug to help us improve Symaira EraseMe
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report. Please provide
+        as much detail as possible to help us reproduce and fix the issue.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of the bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this issue?
+      placeholder: |
+        1. Run 'symeraseme ...'
+        2. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened instead?
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: Please provide relevant environment details.
+      placeholder: |
+        - OS: macOS 14.5
+        - Python: 3.12
+        - Symaira EraseMe version: 0.1.0
+        - Installation method: pip / uv
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant Log Output
+      description: Copy and paste any relevant log output or error messages.
+      render: shell
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Confirmations
+      options:
+        - label: I have searched the existing issues and this is not a duplicate.
+          required: true
+        - label: I have provided reproduction steps and environment details.
+          required: true

symeraseme-0.1.4/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussions
+    url: https://github.com/danieljustus/symaira-eraseme/discussions
+    about: Please ask questions and discuss ideas in GitHub Discussions.
+  - name: Security
+    url: https://github.com/danieljustus/symaira-eraseme/security/policy
+    about: Please report security vulnerabilities privately.

symeraseme-0.1.4/.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,49 @@
+name: Feature Request
+description: Suggest an idea for Symaira EraseMe
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a feature! Please describe your idea clearly
+        so the community and maintainers can understand and discuss it.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of the feature you'd like.
+    validations:
+      required: true
+
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: Why is this feature needed? What problem does it solve?
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: How do you envision this feature working?
+      placeholder: A CLI flag, a new command, a config option, etc.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: What alternatives have you considered?
+      placeholder: Workarounds, other tools, different approaches, etc.
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Confirmations
+      options:
+        - label: I have searched the existing issues and this is not a duplicate.
+          required: true

symeraseme-0.1.4/.github/PULL_REQUEST_TEMPLATE/broker_update.md

@@ -0,0 +1,39 @@
+## Summary
+
+<!-- Describe what changed and why -->
+
+## Registry Changes
+
+<!-- Check all that apply -->
+- [ ] New broker added
+- [ ] Existing broker updated
+- [ ] Broker removed (out of business / merged)
+- [ ] Schema change
+
+## Broker Details
+
+| Field | Value |
+|-------|-------|
+| **Broker Name** | <!-- Full legal name --> |
+| **Broker ID** | <!-- e.g., acme-corp-us --> |
+| **Category** | <!-- people-search / marketing / credit / ... --> |
+| **Jurisdiction** | <!-- US / EU / UK --> |
+| **Source** | <!-- Where you found/verified this broker --> |
+
+## Verification
+
+- [ ] YAML file validates against `broker.schema.json`
+- [ ] No duplicate entries (checked against existing registry)
+- [ ] Website URL is reachable (if checked)
+- [ ] Opt-out method is verified (email or web form)
+- [ ] Source is documented and verifiable
+
+## Schema Changes (if applicable)
+
+- [ ] Schema version bumped
+- [ ] Backwards compatible
+- [ ] Documentation updated
+
+## Notes
+
+<!-- Any additional context, warnings, or special considerations -->

symeraseme-0.1.4/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,45 @@
+## Description
+
+Please include a summary of the change and which issue is fixed.
+
+Fixes # (issue)
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Registry addition (new broker, jurisdiction, etc.)
+- [ ] Refactor / chore
+
+## Checklist
+
+- [ ] I have linked the issue this PR addresses (see above).
+- [ ] I have run `pytest` and all tests pass.
+- [ ] I have run `ruff check .` and `mypy src/symeraseme/` with no errors.
+- [ ] I have added tests for any new functionality.
+- [ ] I have updated the README or documentation if this change is user-facing.
+- [ ] I have checked for sensitive data (API keys, credentials, etc.) in my changes.
+- [ ] My commit messages follow the project's style (descriptive, no `WIP`).
+
+## Registry Additions (fill in if applicable)
+
+If this PR adds or modifies broker YAML files, complete this section.
+
+- [ ] YAML validates against `registry/schemas/broker.schema.json` (`symeraseme registry validate`)
+- [ ] Broker `id` is unique and matches the filename (e.g. `beenverified-us` → `beenverified.yaml`)
+- [ ] Opt-out URL / email address is reachable and verified manually
+- [ ] At least one `ack_keywords` entry reflects the actual confirmation text from the broker
+- [ ] CAPTCHAs: site_key is the live value from the page DOM (not a placeholder)
+- [ ] `disabled: true` is set for any opt-out channel that cannot yet be verified end-to-end
+- [ ] No personal data, real API keys, or solver credentials included in the YAML
+
+**Brokers added / modified:**
+
+| File | Broker | Region | Opt-out type | Status |
+|------|--------|--------|-------------|--------|
+| `registry/brokers/.../xxx.yaml` | Name | US/EU/UK | email/web_form | new/updated |
+
+## Additional Context
+
+Add any other context about the pull request here.

symeraseme-0.1.4/.github/SECURITY.md

@@ -0,0 +1,37 @@
+# Security Policy
+
+## Supported Versions
+
+This project is in **alpha** stage (Development Status :: 3 - Alpha). Only the latest release
+receives security patches. No long-term support is provided for older versions.
+
+| Version | Supported |
+| ------- | --------- |
+| latest  | Yes       |
+| < latest| No        |
+
+## Reporting a Vulnerability
+
+We take security seriously. If you discover a security vulnerability in Symaira EraseMe,
+please report it privately.
+
+### Preferred: GitHub Security Advisory
+
+Go to the repository's **Security** tab and use the **Report a vulnerability** feature
+to submit a private advisory. This ensures the issue is disclosed responsibly and
+allows us to prepare a fix before public disclosure.
+
+Please include:
+- A description of the vulnerability
+- Steps to reproduce (if applicable)
+- Potential impact
+- Any suggested remediation (optional)
+
+### What to Expect
+
+- You will receive an acknowledgment within 72 hours.
+- We will assess the report and provide an estimated timeline for a fix.
+- Once resolved, we will publish a security advisory and credit the reporter
+  (unless you prefer to remain anonymous).
+
+Thank you for helping keep Symaira EraseMe and its users safe.