anylumino 0.1.0__tar.gz

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

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+
+      - name: Install frontend dependencies
+        run: npm ci
+
+      - name: Build frontend bundles
+        run: npm run build
+
+      - name: Verify committed bundles are current
+        run: git diff --exit-code -- src/anylumino/static
+
+      - name: Regenerate bundled dependency licenses
+        run: npm run licenses
+
+      - name: Verify the license inventory is current
+        run: git diff --exit-code -- THIRD_PARTY_LICENSES.md
+
+      - name: Run frontend tests
+        run: npm test
+
+      - name: Install Python dependencies
+        run: uv sync --dev
+
+      - name: Check documentation
+        run: make docs-check
+
+      - name: Run tests
+        run: uv run --no-sync pytest
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Validate distributions for publication
+        run: uv publish --dry-run --trusted-publishing never dist/*
+
+      - name: Test installed wheel
+        run: |
+          uv venv /tmp/anylumino-wheel
+          uv pip install --python /tmp/anylumino-wheel/bin/python dist/*.whl
+          cd /tmp
+          /tmp/anylumino-wheel/bin/python - <<'PY'
+          import anylumino as al
+          import anylumino.astryx as ax
+
+          panel = al.TabPanel({"text": ax.Text("Wheel check")})
+          assert panel.child_keys == ["text"]
+          for widget in (panel, panel["text"], al.DatePicker()):
+              state = widget.get_state()
+              assert "export" in state["_esm"]
+              assert "anylumino" in state["_css"]
+          PY

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

@@ -0,0 +1,65 @@
+name: Docs
+
+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:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+
+      - name: Install dependencies
+        run: |
+          npm ci
+          uv sync --dev
+
+      - name: Build the documentation site
+        env:
+          NEXT_PUBLIC_BASE_PATH: /anylumino
+        run: make docs
+
+      - name: Upload the exported site
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: out
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

anylumino-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,123 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      index:
+        description: Index to publish to
+        type: choice
+        options: [pypi, testpypi]
+        default: testpypi
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+
+      - name: Build frontend bundles
+        run: |
+          npm ci
+          npm run build
+
+      - name: Verify committed bundles are current
+        run: git diff --exit-code -- src/anylumino/static
+
+      - name: Verify the tag matches the project version
+        if: github.ref_type == 'tag'
+        run: |
+          version="$(uv version --short)"
+          if [ "v$version" != "${{ github.ref_name }}" ]; then
+            echo "Tag ${{ github.ref_name }} does not match project version $version"
+            exit 1
+          fi
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Validate distributions for publication
+        run: uv publish --dry-run --trusted-publishing never dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: distributions
+          path: dist
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+
+    # Trusted Publishing exchanges this job's OIDC token for a short-lived
+    # upload token, so the workflow needs no stored PyPI credentials.
+    environment: ${{ github.event.inputs.index || 'pypi' }}
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: distributions
+          path: dist
+
+      - name: Publish to PyPI
+        if: github.event.inputs.index != 'testpypi'
+        run: uv publish dist/*
+
+      - name: Publish to TestPyPI
+        if: github.event.inputs.index == 'testpypi'
+        run: uv publish --publish-url https://test.pypi.org/legacy/ dist/*
+
+  attach:
+    needs: build
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: distributions
+          path: dist
+
+      - name: Attach distributions to the release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          if gh release view "$TAG" > /dev/null 2>&1; then
+            gh release upload "$TAG" dist/* --clobber
+          else
+            gh release create "$TAG" dist/* --verify-tag --generate-notes --title "anylumino ${TAG#v}"
+          fi

anylumino-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+.venv/
+.uv-cache/
+node_modules/
+.next/
+out/
+*.tsbuildinfo
+.pytest_cache/
+.ipynb_checkpoints/
+**/.ipynb_checkpoints/
+__pycache__/
+**/__pycache__/
+*.py[cod]
+*.ipynb
+*.egg-info/
+dist/
+build/
+.DS_Store

anylumino-0.1.0/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Unreleased
+
+- Documented the `uv` build, validation, TestPyPI, and PyPI release workflow.
+- Added contributor setup and verification guidance.

anylumino-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+Install the development dependencies and build the frontend before running the
+checks:
+
+```sh
+uv sync --group dev
+npm ci
+npm run build
+```
+
+Run `uv run --no-sync pytest` for Python tests, `npm test` for frontend tests,
+and `make docs-check` for generated API pages, documentation links, linting,
+types, and the production documentation build. Keep generated frontend bundles
+current by running `npm run build` after frontend changes, and regenerate
+`THIRD_PARTY_LICENSES.md` with `npm run licenses` after frontend dependency
+changes. CI verifies both files.
+
+Keep pull requests focused. Add or update a runnable notebook when a change
+introduces a user-facing widget pattern, and update the relevant documentation
+when public behavior changes.
+
+Releases run from a `v*` tag. Bump the version in `pyproject.toml`, tag the
+release commit, and push the tag; the Release workflow builds the
+distributions, attaches them to the GitHub release, and publishes to PyPI
+through Trusted Publishing.

anylumino-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Faysal Aberkane <faysal.aberkane@gmail.com>
+
+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.

anylumino-0.1.0/Makefile

@@ -0,0 +1,72 @@
+DOCS_PORT ?= 4200
+DOCS_HOST ?= 127.0.0.1
+OPEN ?= open
+DOCS_URL = http://$(DOCS_HOST):$(DOCS_PORT)/docs
+
+.PHONY: install-dev
+install-dev:
+	uv sync --group dev
+	npm ci
+	npm run build
+	uv run --no-sync jupytext-config set-default-viewer
+
+.PHONY: update-dependencies
+update-dependencies:
+	uv lock \
+		--upgrade-package anywidget \
+		--upgrade-package jupyter \
+		--upgrade-package jupyterlab \
+		--upgrade-package jupyter-builder
+	npm install --save-exact @lumino/commands@latest @lumino/widgets@latest
+	npm install --save-prefix='^' @astryxdesign/core@latest @astryxdesign/theme-neutral@latest
+	npm install --save-dev --save-prefix='^' @astryxdesign/cli@latest
+	npm run build
+
+.PHONY: frontend
+frontend:
+	npm run build
+
+.PHONY: test
+test:
+	npm test
+	uv run pytest
+
+.PHONY: docs-reference
+docs-reference: docs-install
+	@mkdir -p build/docs
+	PYTHONPATH=node_modules/fumadocs-python:src uv run --no-sync python -c 'from fumapy import generate; generate()' anylumino --docstring-style numpy --dir build/docs
+	npm run docs:convert
+
+.PHONY: docs-install
+docs-install:
+	uv sync --group dev
+	npm ci
+
+.PHONY: docs-check-port
+docs-check-port:
+	@if lsof -nP -iTCP:$(DOCS_PORT) -sTCP:LISTEN >/dev/null 2>&1; then \
+		echo "Port $(DOCS_PORT) is already in use. Stop the process below or run with DOCS_PORT=<free-port>:"; \
+		lsof -nP -iTCP:$(DOCS_PORT) -sTCP:LISTEN; \
+		exit 1; \
+	fi
+
+.PHONY: docs
+docs: docs-reference
+	npm run docs:build
+
+.PHONY: docs-preview
+docs-preview: docs-reference
+	(sleep 2; $(OPEN) $(DOCS_URL)) &
+	npm run docs:dev -- --hostname $(DOCS_HOST) --port $(DOCS_PORT)
+
+.PHONY: docs-serve
+docs-serve: docs-check-port docs
+	(sleep 1; $(OPEN) $(DOCS_URL)) &
+	uv run --no-sync python -m http.server $(DOCS_PORT) --bind $(DOCS_HOST) --directory out
+
+.PHONY: docs-check
+docs-check: docs-reference
+	npm run docs:test-links
+	npm run docs:lint
+	npm run docs:types
+	npm run docs:build