sk4n 0.1.0__tar.gz

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

@@ -0,0 +1,120 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  UV_NO_PROGRESS: "1"
+
+jobs:
+  tests:
+    name: Tests (${{ matrix.os }}, Python ${{ matrix.python-version }})
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: "3.11"
+          - os: ubuntu-latest
+            python-version: "3.12"
+          - os: ubuntu-latest
+            python-version: "3.13"
+          - os: ubuntu-latest
+            python-version: "3.14"
+          - os: macos-latest
+            python-version: "3.14"
+          - os: windows-latest
+            python-version: "3.14"
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          version: "0.11.17"
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install the locked project and development dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Run unit tests
+        run: uv run --locked pytest -q
+
+  source-checks:
+    name: Source checks
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          version: "0.11.17"
+          python-version: "3.14"
+          enable-cache: true
+
+      - name: Install the locked project and development dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Run Ruff
+        run: uv run --locked ruff --config pyproject.toml check .
+
+      - name: Run Pyright
+        run: uv run --locked pyright
+
+      - name: Check generated CLI references
+        run: uv run --locked python scripts/generate_skill_references.py --check
+
+  package:
+    name: Package artifacts
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv and the minimum supported Python
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          version: "0.11.17"
+          python-version: "3.11"
+          enable-cache: true
+
+      - name: Install the locked project and development dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Build wheel and source distribution
+        run: uv run --locked python -m build
+
+      - name: Check package metadata
+        run: uv run --locked twine check --strict dist/*
+
+      - name: Inspect and clean-install both artifacts with pip
+        run: uv run --locked python scripts/validate_package.py dist

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

@@ -0,0 +1,241 @@
+name: Release
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.event.release.tag_name }}
+  cancel-in-progress: false
+
+env:
+  UV_NO_PROGRESS: "1"
+
+jobs:
+  ci:
+    name: Run CI for the release commit
+    permissions:
+      contents: read
+    uses: $/.github/workflows/ci.yml
+
+  build:
+    name: Build and validate release artifacts
+    needs:
+      - ci
+    runs-on: ubuntu-latest
+    timeout-minutes: 25
+    outputs:
+      version: ${{ steps.package-version.outputs.version }}
+
+    steps:
+      - name: Check out the release tag
+        uses: actions/checkout@v7
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          persist-credentials: false
+
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          version: "0.11.17"
+          python-version: "3.14"
+          enable-cache: true
+
+      - name: Install the locked project and development dependencies
+        run: uv sync --locked --all-groups
+
+      - name: Verify that the release tag matches the package version
+        id: package-version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          package_version="$(uv run --locked python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          if [[ "$RELEASE_TAG" != "v$package_version" ]]; then
+            echo "Release tag $RELEASE_TAG does not match package version $package_version." >&2
+            exit 1
+          fi
+          echo "version=$package_version" >> "$GITHUB_OUTPUT"
+
+      - name: Audit the locked environment
+        run: uv run --locked pip-audit --local --skip-editable --progress-spinner off
+
+      - name: Audit the allowed runtime dependency range
+        run: >-
+          uv run --locked pip-audit
+          --strict
+          --progress-spinner off
+          .
+
+      - name: Build wheel and source distribution
+        run: uv run --locked python -m build
+
+      - name: Check package metadata
+        run: uv run --locked twine check --strict dist/*
+
+      - name: Inspect and clean-install both artifacts with pip
+        run: uv run --locked python scripts/validate_package.py dist
+
+      - name: Store the exact release artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+          overwrite: true
+          retention-days: 90
+
+  github-release-assets:
+    name: Attach artifacts to the GitHub Release
+    needs:
+      - build
+      - publish-pypi
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: write
+
+    steps:
+      - name: Download the release artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Attach the artifacts
+        env:
+          GH_TOKEN: ${{ github.token }}
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: gh release upload "$RELEASE_TAG" dist/* --clobber --repo "$GITHUB_REPOSITORY"
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/sk4n
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download the release artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish the artifacts to TestPyPI
+        uses: pypa/gh-action-pypi-publish@v1.14.2
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          print-hash: true
+          attestations: true
+
+  test-testpypi:
+    name: Test TestPyPI (${{ matrix.os }})
+    needs:
+      - build
+      - publish-testpypi
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.14"
+
+      - name: Download the original release artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: release-dist/
+
+      - name: Download the published wheel from TestPyPI
+        shell: bash
+        env:
+          PACKAGE_VERSION: ${{ needs.build.outputs.version }}
+        run: |
+          for attempt in 1 2 3 4 5 6; do
+            if python -m pip download \
+              --disable-pip-version-check \
+              --no-cache-dir \
+              --no-deps \
+              --index-url https://test.pypi.org/simple/ \
+              --dest test-dist \
+              "sk4n==$PACKAGE_VERSION"; then
+              break
+            fi
+            if [[ "$attempt" == "6" ]]; then
+              exit 1
+            fi
+            sleep 10
+          done
+
+      - name: Verify that TestPyPI served the original wheel
+        run: >-
+          python -c
+          "from pathlib import Path;
+          original=list(Path('release-dist').glob('sk4n-*.whl'));
+          published=list(Path('test-dist').glob('sk4n-*.whl'));
+          assert len(original) == len(published) == 1;
+          assert original[0].read_bytes() == published[0].read_bytes()"
+
+      - name: Install the TestPyPI wheel with dependencies from PyPI
+        shell: bash
+        run: python -m pip install --disable-pip-version-check test-dist/sk4n-*.whl
+
+      - name: Exercise the installed package and console scripts
+        shell: bash
+        env:
+          PACKAGE_VERSION: ${{ needs.build.outputs.version }}
+          SK4N_HOME: ${{ runner.temp }}/sk4n-release-smoke
+        run: |
+          python -c 'import os; from importlib.metadata import version; assert version("sk4n") == os.environ["PACKAGE_VERSION"]'
+          sk4n --help
+          canvas --help
+          nusmods --help
+          talent-connect --help
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs:
+      - build
+      - test-testpypi
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sk4n
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download the original release artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish the artifacts to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.14.2
+        with:
+          skip-existing: true
+          print-hash: true
+          attestations: true

sk4n-0.1.0/.gitignore

@@ -0,0 +1,232 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+temp/
+sessions/
+data/
+.DS_Store
+._*
+desktop.ini
+Thumbs.db
+
+.playwright/
+.playwright-cli/
+.claude/
+.agents/
+.agent/

sk4n-0.1.0/AGENT.md

@@ -0,0 +1,97 @@
+# Maintainer agent guide
+
+This file is guidance for agents maintaining this repository. It is not the
+operating prompt for an end-user-facing NUS assistant.
+
+nus-canvas, nus-talent-connect and nusmods skills may have been installed to you, those are for end-user-facing NUS assistant. 
+
+## Repository map
+
+- `src/sk4n/canvas/` provides authenticated, read-only Canvas queries, targeted cache
+  refreshes, bulk synchronization, direct authenticated API
+  access, and authenticated `@playwright/cli` sessions.
+- `src/sk4n/talent_connect/` provides public and authenticated Kinobi job/company
+  access, local SQLite persistence, direct authenticated API access, and
+  authenticated `@playwright/cli` sessions.
+- `src/sk4n/nusmods/` uses public NUSMods APIs and does not need an authentication flow.
+- `src/sk4n/tools/` contains shared request, saved-session, and browser-session helpers.
+- `tests/` contains the unit suite. Keep application-specific behavior in its
+  package and put genuinely shared behavior in `src/sk4n/tools/`.
+
+For check / build / test, refer to the justfile under repo root.
+Prefer running the just commands like `just check` as is.
+
+## Authentication comes first
+
+Before any Canvas or TalentConnect task that may contact the real service,
+always check authentication status first:
+
+```bash
+uv run canvas auth status
+uv run talent-connect auth status
+```
+
+If the relevant command reports unauthenticated and the task needs actual
+access, ask the user for approval to start authentication. Once approved, run
+the appropriate command below and ask the user to complete NUS SSO in the
+browser window:
+
+```bash
+uv run canvas auth login
+uv run talent-connect auth login
+```
+
+Do not require authentication for NUSMods: its APIs are public, so use direct
+requests or available browser skills as appropriate.
+
+Prefer the repository's direct authenticated `api` command for endpoint
+discovery and validation. It reuses the durable saved login and has lower cost
+and overhead than a built-in browser/app connector. When page-level inspection
+is necessary, use the repository's `playwright-cli` command; it injects that
+same saved authentication into a named `@playwright/cli` session that later CLI
+commands can reuse. Avoid built-in app/browser connectors for Canvas and
+TalentConnect maintenance because their authentication is not persisted for
+subsequent repository commands and they add unnecessary overhead.
+
+```bash
+uv run canvas api /api/v1/users/self/profile
+uv run canvas playwright-cli --session canvas
+
+uv run talent-connect api /api/auth/
+uv run talent-connect playwright-cli --session talent-connect
+```
+
+The browser-opening commands leave their sessions running. Continue with, for
+example, `playwright-cli -s=canvas snapshot`, and close a session explicitly
+when the task is finished.
+
+## Updating a remote integration
+
+Remote interfaces change. When adding support for a new or updated Canvas or
+TalentConnect page, field, endpoint, filter, or workflow:
+
+1. Check auth status before beginning remote investigation.
+2. Inspect the smallest useful read-only API call first with the app's `api`
+   command. Use the authenticated `playwright-cli` session for network, DOM, or
+   interaction details that the direct API cannot reveal.
+3. Record the observed request/response contract and preserve existing unknown
+   fields unless there is a reason to normalize them.
+4. Implement the narrowest package-local change, sharing only infrastructure
+   that truly applies to multiple apps.
+5. Add or update deterministic unit tests, then run the focused tests and the
+   full unit suite.
+6. Follow unit tests with safe real-service end-to-end checks when remote
+   behavior is relevant. Read-only checks such as auth status, profile fetches,
+   small list/detail requests, and page inspection are allowed and encouraged
+   by default unless the user says otherwise.
+
+Real read-only API calls and actual use of the repository's `playwright-cli`
+commands are allowed by default and are required for many remote-integration
+tasks; mocks alone are not proof that a changed remote interface still works.
+
+Any operation that would exercise real write access on the user's behalf needs
+the user's explicit approval first. This includes creating, editing, deleting,
+submitting, applying, bookmarking, messaging, enrolling, or otherwise changing
+remote state. Approval for read-only investigation does not imply approval for
+writes. Prefer a read-only status/detail request as the end-to-end smoke test
+whenever it can validate the implementation safely.

sk4n-0.1.0/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0
+
+- Initial public release.
+- Provide Canvas, NUSMods, TalentConnect, and shared `sk4n` command-line tools.
+- Bundle agent skills for the supported NUS services. Provide cli commands to skill management
+
+[0.1.0]: https://github.com/hykzr/sk4n/releases/tag/v0.1.0