snackapp 0.1.1__tar.gz

snackapp-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+# Publish snackapp to PyPI via trusted publishing (OIDC). No API token.
+# Publish snackbase first. Configure the PyPI trusted publisher for this
+# workflow before pushing a v* tag.
+name: publish
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+

snackapp-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,74 @@
+name: Tests
+on:
+  pull_request:
+  push:
+    branches: [main]
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          path: snackapp
+      - uses: actions/checkout@v4
+        with:
+          repository: lalitgehani/SnackBase
+          path: SnackBase
+      - uses: astral-sh/setup-uv@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Test
+        working-directory: snackapp
+        run: |
+          uv sync --dev
+          uv run ruff check .
+          uv run pytest --cov --cov-fail-under=80
+          uv build
+      - name: Build snackbase wheel
+        working-directory: SnackBase
+        run: uv build
+      - name: pip-install wheels without uv
+        working-directory: snackapp
+        shell: bash
+        run: |
+          python -m venv .ci-venv
+          if [ -x .ci-venv/bin/python ]; then
+            PY=.ci-venv/bin/python
+          else
+            PY=.ci-venv/Scripts/python
+          fi
+          "$PY" -m pip install ../SnackBase/dist/snackbase-*.whl dist/snackapp-*.whl
+          "$PY" -m snackapp --help
+          "$PY" -m snackapp --version
+
+  install-testpypi:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: pip install snackapp from TestPyPI
+        shell: bash
+        run: |
+          python -m venv .ci-venv
+          if [ -x .ci-venv/bin/python ]; then
+            PY=.ci-venv/bin/python
+          else
+            PY=.ci-venv/Scripts/python
+          fi
+          "$PY" -m pip install -U pip
+          "$PY" -m pip install --only-binary=:all: \
+            --extra-index-url https://test.pypi.org/simple/ \
+            snackapp==0.1.1 snackbase==0.12.1
+          "$PY" -m snackapp --help
+          "$PY" -m snackapp --version

snackapp-0.1.1/.gitignore

@@ -0,0 +1,17 @@
+.snackapp/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+dist/
+*.egg-info/
+node_modules/
+frontend/dist/
+.DS_Store
+.venv/
+.pip-verify-venv/
+.pip-verify-venv-*/
+.pip-verify-demo/

snackapp-0.1.1/.python-version

@@ -0,0 +1 @@
+3.14

snackapp-0.1.1/Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.12-slim
+WORKDIR /app
+COPY dist/*.whl /tmp/
+RUN pip install --no-cache-dir /tmp/*.whl
+EXPOSE 8000
+CMD ["snackapp", "run", "--host", "0.0.0.0", "--port", "8000"]

snackapp-0.1.1/Makefile

@@ -0,0 +1,11 @@
+.PHONY: build-frontend test
+
+build-frontend:
+	rm -rf src/snackapp/static/assets
+	mkdir -p src/snackapp/static/assets
+	cd frontend && npm ci && npm run build
+
+test:
+	uv run ruff check .
+	uv run mypy src/
+	uv run pytest --cov

snackapp-0.1.1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.5
+Name: snackapp
+Version: 0.1.1
+Summary: Python application framework with SnackBase embedded
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1.0
+Requires-Dist: fastapi>=0.127.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: snackbase>=0.12.1
+Requires-Dist: uvicorn[standard]>=0.50.0
+Description-Content-Type: text/markdown
+
+# SnackApp
+
+A Python application framework with SnackBase embedded. One install, one command, a working multi-user app.
+
+```bash
+python -m pip install --only-binary=:all: \
+  --extra-index-url https://test.pypi.org/simple/ \
+  snackapp==0.1.1 snackbase==0.12.1
+snackapp init demo
+cd demo
+snackapp run
+```
+
+`--only-binary=:all:` keeps pip from building TestPyPI source distributions (TestPyPI hosts a broken FastAPI sdist). Dependencies that are not on TestPyPI still resolve from PyPI.
+
+When `snackapp` is on [pypi.org](https://pypi.org/project/snackapp/), `pip install snackapp` is enough.
+
+Open http://localhost:8000 and log in with the credentials printed on first boot.
+
+![SnackApp home after first login](docs/quickstart.png)
+
+See `examples/crm` for a Twenty-inspired CRM built only on the public API.
+
+## Versioning
+
+SnackApp is `0.1.1`. Before `1.0`, breaking changes may appear in minor releases. Pin `snackapp~=0.1` if you need a freeze.
+
+## Publishing
+
+`snackbase 0.12.1` and `snackapp 0.1.1` are on [TestPyPI](https://test.pypi.org/project/snackapp/). CI publishes to PyPI from a `v*` tag using [trusted publishing](https://docs.pypi.org/trusted-publishers/) (`id-token: write`, no API token in the repo). Publish `snackbase` first, then `snackapp`.
+
+PyPI trusted publisher settings (once the production PyPI projects exist):
+
+| Field | snackbase | snackapp |
+| --- | --- | --- |
+| Owner | `lalitgehani` | `lalitgehani` |
+| Repository | `SnackBase` | `snackapp` |
+| Workflow | `publish.yml` | `publish.yml` |
+| Environment | `pypi` | `pypi` |
+
+Do not push a `v*` tag until those publishers are saved on pypi.org.
+
+## Docs
+
+- Install, tutorial, `ui.*`, field types: `docs/` in this repo and [SnackApp in the SnackBase docs](https://docs.snackbase.dev/guides/snackapp)
+- Deployment: [`docs/DEPLOY.md`](docs/DEPLOY.md)

snackapp-0.1.1/README.md

@@ -0,0 +1,46 @@
+# SnackApp
+
+A Python application framework with SnackBase embedded. One install, one command, a working multi-user app.
+
+```bash
+python -m pip install --only-binary=:all: \
+  --extra-index-url https://test.pypi.org/simple/ \
+  snackapp==0.1.1 snackbase==0.12.1
+snackapp init demo
+cd demo
+snackapp run
+```
+
+`--only-binary=:all:` keeps pip from building TestPyPI source distributions (TestPyPI hosts a broken FastAPI sdist). Dependencies that are not on TestPyPI still resolve from PyPI.
+
+When `snackapp` is on [pypi.org](https://pypi.org/project/snackapp/), `pip install snackapp` is enough.
+
+Open http://localhost:8000 and log in with the credentials printed on first boot.
+
+![SnackApp home after first login](docs/quickstart.png)
+
+See `examples/crm` for a Twenty-inspired CRM built only on the public API.
+
+## Versioning
+
+SnackApp is `0.1.1`. Before `1.0`, breaking changes may appear in minor releases. Pin `snackapp~=0.1` if you need a freeze.
+
+## Publishing
+
+`snackbase 0.12.1` and `snackapp 0.1.1` are on [TestPyPI](https://test.pypi.org/project/snackapp/). CI publishes to PyPI from a `v*` tag using [trusted publishing](https://docs.pypi.org/trusted-publishers/) (`id-token: write`, no API token in the repo). Publish `snackbase` first, then `snackapp`.
+
+PyPI trusted publisher settings (once the production PyPI projects exist):
+
+| Field | snackbase | snackapp |
+| --- | --- | --- |
+| Owner | `lalitgehani` | `lalitgehani` |
+| Repository | `SnackBase` | `snackapp` |
+| Workflow | `publish.yml` | `publish.yml` |
+| Environment | `pypi` | `pypi` |
+
+Do not push a `v*` tag until those publishers are saved on pypi.org.
+
+## Docs
+
+- Install, tutorial, `ui.*`, field types: `docs/` in this repo and [SnackApp in the SnackBase docs](https://docs.snackbase.dev/guides/snackapp)
+- Deployment: [`docs/DEPLOY.md`](docs/DEPLOY.md)

snackapp-0.1.1/docs/DEPLOY.md

@@ -0,0 +1,46 @@
+# Deploying SnackApp
+
+## Install
+
+Until the packages are on pypi.org, install the TestPyPI wheels and take
+dependencies from PyPI:
+
+```bash
+python -m pip install --only-binary=:all: \
+  --extra-index-url https://test.pypi.org/simple/ \
+  snackapp==0.1.1 snackbase==0.12.1
+```
+
+`--only-binary=:all:` is required: TestPyPI has a broken FastAPI sdist that
+pip otherwise tries to build. After the production PyPI projects exist,
+`pip install snackapp` is enough.
+
+## Single process with SQLite
+
+```bash
+snackapp init myapp && cd myapp
+snackapp run --host 0.0.0.0 --port 8000
+```
+
+
+## PostgreSQL
+
+Set `SNACKBASE_DATABASE_URL=postgresql+asyncpg://user:pass@host/db` before
+`snackapp run`. Keep `.snackapp/secret.key` mode 0600.
+
+## Docker
+
+See the repository `Dockerfile`. Build the wheel first (`uv build`), then
+`docker build`.
+
+## Trusted publishing
+
+Neither repository stores a PyPI token. On tag `v*`, GitHub Actions uses
+OIDC (`id-token: write`) with `pypa/gh-action-pypi-publish`.
+
+Before the first tag, an owner must:
+
+1. Create the PyPI projects `snackbase` then `snackapp` (or claim the names).
+2. Add a trusted publisher: GitHub org/user, repository, workflow `publish.yml`,
+   environment `pypi`.
+3. Tag and push `v0.12.1` on SnackBase, then `v0.1.1` on snackapp.

snackapp-0.1.1/pyproject.toml

@@ -0,0 +1,79 @@
+[project]
+name = "snackapp"
+version = "0.1.1"
+description = "Python application framework with SnackBase embedded"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+dependencies = [
+    "snackbase>=0.12.1",
+    "fastapi>=0.127.0",
+    "uvicorn[standard]>=0.50.0",
+    "httpx>=0.28.1",
+    "click>=8.1.0",
+    "python-dotenv>=1.0.1",
+]
+
+[project.scripts]
+snackapp = "snackapp.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/snackapp"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/tests", "/frontend", "/examples"]
+
+[tool.uv.sources]
+snackbase = { path = "../SnackBase", editable = true }
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.24.0",
+    "pytest-cov>=5.0.0",
+    "ruff>=0.8.0",
+    "mypy>=1.13.0",
+    "httpx>=0.28.0",
+]
+
+[tool.ruff]
+target-version = "py314"
+line-length = 100
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["snackapp"]
+
+[tool.ruff.lint.per-file-ignores]
+"examples/**/\\[id\\].py" = ["N999"]
+
+[tool.mypy]
+python_version = "3.12"
+ignore_missing_imports = true
+warn_unused_ignores = false
+disallow_untyped_defs = false
+check_untyped_defs = false
+mypy_path = "src"
+
+[tool.coverage.run]
+source = ["src/snackapp"]
+omit = ["src/snackapp/__main__.py"]
+branch = false
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]
+addopts = "--cov=snackapp --cov-report=term-missing"
+filterwarnings = [
+    "ignore:Using `httpx` with `starlette.testclient` is deprecated.*",
+    "ignore:The anyio.abc.BlockingPortal alias is deprecated.*",
+]

snackapp-0.1.1/src/snackapp/__init__.py

@@ -0,0 +1,26 @@
+"""SnackApp — Python application framework with SnackBase embedded."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from snackapp import ui
+from snackapp.app import App, Ctx, Table
+from snackapp.discovery import action, page
+from snackapp.schema import Field, Schema, rules_for
+
+try:
+    __version__ = version("snackapp")
+except PackageNotFoundError:
+    __version__ = "0.1.1"
+
+__all__ = [
+    "App",
+    "Ctx",
+    "Field",
+    "Schema",
+    "Table",
+    "action",
+    "page",
+    "rules_for",
+    "ui",
+    "__version__",
+]

snackapp-0.1.1/src/snackapp/__main__.py

@@ -0,0 +1,6 @@
+"""`python -m snackapp` is equivalent to the `snackapp` console script."""
+
+from snackapp.cli import main
+
+if __name__ == "__main__":
+    main()