Skip to content
SkeinRank SkeinRank

Installation

SkeinRank can be tried in two ways:

  • local SDK/CLI for dictionary validation, extraction, and canonicalization;
  • Docker beta stack for the governance console, API, PostgreSQL, Elasticsearch, RabbitMQ worker, and optional observability profile.

Requirements

Section titled “Requirements”
  • Python 3.10+
  • Node.js 22+ for this website scaffold
  • Poetry for source checkout development
  • Docker Compose V2 for the platform beta stack

Run the platform beta with Docker

Section titled “Run the platform beta with Docker”

For the full governance console path, use the Docker beta quickstart:

Terminal window
git clone https://github.com/SkeinRank/skeinrank.git
cd skeinrank
cp .env.example .env
docker compose -f docker-compose.dev.yml up --build -d

Then open:

http://127.0.0.1:5173

Read the full guide for auth, observability, reset commands, and troubleshooting:

Open Docker beta quickstart

Install the core package

Section titled “Install the core package”

When the package is available on PyPI:

Terminal window
python -m pip install skeinrank

For TestPyPI smoke testing:

Terminal window
python -m pip install \
  --index-url https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple/ \
  skeinrank

Install from the repository

Section titled “Install from the repository”
Terminal window
git clone https://github.com/SkeinRank/skeinrank.git
cd skeinrank/packages/skeinrank-core
poetry install
poetry run pytest -q

Website local run

Section titled “Website local run”

This ZIP is a separate website repository scaffold.

Terminal window
npm install
npm run dev

Open the local URL printed by Astro, usually:

http://localhost:4321

GitHub Pages target

Section titled “GitHub Pages target”

Use a separate repository:

SkeinRank/skeinrank.github.io

That repository can serve GitHub Pages at https://skeinrank.github.io and later use the custom domain https://skeinrank.io through GitHub Pages settings and DNS.