Skip to content

Installation Guide

Get started with kand through Python or Docker. This guide covers all installation methods and system compatibility details.

Python Installation

Requirements

  • Python 3.8+
  • pip (Python package installer)

Install from PyPI

Install kand with one command—precompiled wheels available for instant setup:

pip install kand

Supported Platforms & Python Versions

We provide precompiled packages on PyPI for major systems and Python versions:

Platform Supported Python Versions
Linux 3.8, 3.9, 3.10, 3.11, 3.12
musl Linux 3.8, 3.9, 3.10, 3.11, 3.12
Windows 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
macOS 3.8, 3.9, 3.10, 3.11, 3.12, 3.13

No compilation needed—just pip install and go!

Docker Usage

Pull the Official Image

Grab the latest kand container:

docker pull ghcr.io/rust-ta/kand:latest

Run with Docker

Launch it interactively:

docker run -it --rm ghcr.io/rust-ta/kand:latest

Or build your own:

docker build -t my-kand-app .
docker run -it --rm my-kand-app

Troubleshooting

Encounter issues? Try these steps:

  1. Update pip or cargo to the latest version.
  2. Verify Python (3.8+) or Rust (1.80+) compatibility.
  3. Ensure the Docker daemon is running.
  4. Check GitHub Issues for solutions.

Note

Still stuck? Join our community or file an issue on GitHub!

Next Steps

  • Explore the API Documentation to dive into kand.
  • Join our community for help and updates.
  • Report bugs or suggestions on GitHub.