silkweb 0.1.0__tar.gz

silkweb-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install package and test tools
+        run: python -m pip install -U pip wheel && python -m pip install -e ".[test]"
+
+      - name: Run tests
+        run: python -m pytest

silkweb-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Deploy documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: python -m pip install -e ".[docs]"
+
+      - name: Build MkDocs site
+        run: python -m mkdocs build --strict
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

silkweb-0.1.0/.gitignore

@@ -0,0 +1,48 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+.venv/
+venv/
+env/
+ENV/
+
+build/
+dist/
+*.egg-info/
+
+.DS_Store
+Thumbs.db
+
+# Editor
+.vscode/
+.idea/
+
+# Local state
+*.log
+silkweb_replays/
+
+# Secrets (create `.env` locally; never commit)
+.env
+.env.local
+
+# MkDocs
+site/
+
+# Local examples and notebooks (not published to remote)
+examples/
+notebooks/
+
+# Optional local-only files (not part of the published tree)
+.githooks/
+
+# Local-only names (not published)
+*.example
+gitignore.template

silkweb-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+## Contributing
+
+Thanks for helping improve Silkweb.
+
+### Development setup
+
+- Python **3.10+**
+- Install in editable mode:
+
+```bash
+python -m pip install -e ".[all]"
+```
+
+The repository includes a root `.gitignore` (do not commit `*.example` files). Create a local `.env` for API keys when needed; do not commit it.
+
+### Linting / formatting
+
+```bash
+ruff check .
+ruff format .
+```
+
+### Guidelines
+
+- Keep the public API in `silkweb/__init__.py` stable.
+- Prefer small, focused PRs.
+- Add or update tests when implementing non-trivial behavior.
+

silkweb-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Silkweb Contributors
+
+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.
+