Skip to content

Getting started

Requirements

  • Python 3.13+
  • uv (recommended for this repository)

Install

git clone https://github.com/kaushalbhavsar/satark.git
cd satark
uv sync --group docs --group dev

Or with pip and venv:

python3.13 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Verify

uv run satark version
uv run satark list-plugins
uv run pytest

Analyze sample insider data

uv run python examples/run_insider_analysis.py
uv run satark analyze -p insider -d examples/data/sample_insider.csv

Local documentation

Documentation only:

uv sync --group docs
uv run mkdocs serve

MkDocs serves documentation at http://127.0.0.1:8000/ during local docs development.

Complete website (marketing site + docs)

rm -rf public
mkdir -p public
cp -R website/. public/
uv run mkdocs build --site-dir public/docs
python -m http.server 8000 --directory public

Then open:

Next