AutoDiscovery for Asta

Changelog

Release notes for the published packages, including breaking changes, are in CHANGELOG.md.

Standalone CLI

To run AutoDiscovery against a local dataset without the full Skiff stack, see docs/autodiscovery/standalone.md for pip install and release instructions.

Setting Up

Install all required packages (including those for testing and documentation) using:

make sync

Running Tests

Execute the test suites with:

make test           # Run main test suite. Excludes Modal Tests
make test-modal     # Run Modal tests only
make test-all       # Run all tests

make test -- --cov  # Run main tests and report coverage

Linting and Formatting

Run Ruff via uv to check code style and lint errors:

make lint

To apply Ruff's formatter, use:

make format

Typing

Run the static type checker with

make type-check

Documentation

Serve the documentation with

make serve-docs

skiff-template-nextjs

This is a template Skiff application with:

• A TypeScript, React and Shellac based user interface (uses only HTML and CSS).
• A NextJS HTTP server, that provides capabilities like server rendering.

You can use this template to start a new Skiff application.

Getting Started

Local Environment

First make sure you have Docker installed, then start local environment by running:

docker compose up --build

The site should be accessible at both http://localhost:3000 and http://localhost:8080. As you make edits, the page should automatically refresh with changes.

Local Development

Most IDEs require the dependencies to be installed locally for things like typechecking and autocompletion.

To do this install nodejs.org and yarn (yes, the version we use is EoL) on your machine. Then run:

cd app/
yarn install --frozen-lockfile

Getting Help

See Skiff's Documentation for more information.

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE and NOTICE files for details.