synthadoc 0.9.1__tar.gz

synthadoc-0.9.1/.gitattributes

@@ -0,0 +1,15 @@
+# Normalize line endings: text files use LF in the repo
+* text=auto eol=lf
+
+# Binaries — no conversion
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.woff binary
+*.woff2 binary
+*.ttf binary
+*.otf binary
+*.eot binary
+*.pdf binary

synthadoc-0.9.1/.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python scripts/update_badges.py --check
+      - run: pytest --cov=synthadoc --cov-report=term-missing -v
+
+  coverage-badge:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e ".[dev]"
+      - run: pytest --cov=synthadoc --cov-report=json -q
+      - run: python scripts/update_badges.py --coverage-json coverage.json
+      - run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add docs/badges.json
+          git diff --staged --quiet || git commit -m "ci: update coverage badge"
+          git push origin HEAD:badges --force
+
+  build-plugin-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+      - run: cd obsidian-plugin && npm install && npm run build && npm test
+      - run: python scripts/sync_plugin.py
+      - name: Fail if compiled plugin files are not committed
+        run: |
+          if ! git diff --exit-code synthadoc/data/obsidian-plugin/; then
+            echo ""
+            echo "ERROR: compiled Obsidian plugin files are out of sync."
+            echo "Run these locally and commit the result before opening a PR:"
+            echo "  cd obsidian-plugin && npm run build"
+            echo "  python scripts/sync_plugin.py"
+            echo "  git add synthadoc/data/obsidian-plugin/"
+            exit 1
+          fi

synthadoc-0.9.1/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # required for OIDC trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

synthadoc-0.9.1/.gitignore

@@ -0,0 +1,28 @@
+__pycache__/
+*.pyc
+.pytest_cache/
+.coverage
+coverage.json
+htmlcov/
+/dist/
+/build/
+*.egg-info/
+.env
+.venv/
+venv/
+node_modules/
+obsidian-plugin/node_modules/
+obsidian-plugin/coverage/
+obsidian-plugin/main.js
+.VSCodeCounter/
+.claude/
+
+# synthadoc operational — never commit
+.synthadoc/
+docs/plans/
+docs/blog/
+docs/*.docx
+synthadoc/demos/*/log.md
+
+# diagram sources — export to PNG/SVG and commit the image instead
+*.drawio

synthadoc-0.9.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+
+# 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 e-mail 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 by opening a [GitHub Issue](https://github.com/axoviq-ai/synthadoc/issues). 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
+

synthadoc-0.9.1/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to Synthadoc
+
+Thank you for your interest in contributing!
+
+## Licensing and CLA
+
+Synthadoc uses a split-licence model:
+
+| Component | Licence | What this means |
+|-----------|---------|-----------------|
+| Core server and all other source files | AGPL-3.0-or-later | Modifications must be released under AGPL |
+| `synthadoc/skills/base.py` | Apache-2.0 | Third-party skills may use **any** licence |
+| `synthadoc/providers/base.py` | Apache-2.0 | Third-party providers may use **any** licence |
+
+This means you can write and distribute custom skills or LLM providers — open source or commercial — without being bound by the AGPL, as long as you only extend the Apache-2.0 base classes and do not modify the AGPL core.
+
+A commercial licence is available separately for enterprise use of the core.
+
+To keep dual-licensing viable, **all contributors must sign a Contributor License Agreement (CLA)** before any pull request can be merged. The CLA grants axoviq.com the right to distribute your contribution under both the AGPL and a commercial licence, while you retain your copyright.
+
+A CLA bot will automatically request a signature when you open your first pull request.
+
+## How to Contribute
+
+1. **Open an issue first** for any non-trivial change so we can discuss the approach before you invest time coding.
+2. **Fork** the repository and create a feature branch from `main`.
+3. **Write tests** — new behaviour must be covered; bug fixes should include a regression test.
+4. **Run the test suite** locally before opening a PR:
+   ```
+   pytest
+   ```
+5. **Add SPDX headers** to any new source files you create:
+   ```python
+   # SPDX-License-Identifier: AGPL-3.0-or-later   # for core files
+   # SPDX-License-Identifier: Apache-2.0           # for new plugin interface files
+   # Copyright (C) 2026 Paul Chen / axoviq.com
+   ```
+6. **Open a pull request** against `main` with a clear description of what changed and why.
+
+## Code Style
+
+- Python: follow PEP 8; use `ruff` for linting.
+- TypeScript: follow the existing eslint/prettier config in `obsidian-plugin/`.
+- Keep commits focused; one logical change per commit.
+
+## Release checklist
+
+- [ ] Update `synthadoc/providers/pricing.py` — verify rates against provider pricing pages, update `_LAST_UPDATED`
+
+Pricing sources to check:
+- Anthropic: https://docs.anthropic.com/en/docs/about-claude/pricing
+- OpenAI: https://openai.com/api/pricing/
+- Gemini: https://ai.google.dev/gemini-api/docs/pricing
+- Groq: https://groq.com/pricing
+
+## Reporting Bugs
+
+Use [GitHub Issues](../../issues). Include steps to reproduce, the full error message, and your OS / Python version.
+
+## Security Issues
+
+Do **not** open a public issue for security vulnerabilities. Email `security@axoviq.com` instead.