Installation

This guide covers different methods for installing the virtual-knitting-machine package depending on your use case.

📦 Standard Installation

From PyPI (Recommended)

The easiest way to install KnitScript is from PyPI using pip:

pip install virtual-knitting-machine

This installs the latest stable release with all required dependencies.

From Test-PyPI (Development Versions)

If you want to try unreleased features, you can install from Test-PyPI:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ virtual-knitting-machine

Note

Development versions may be unstable and are not recommended for production use.

🛠️ Development Installation

From Source (Latest)

To get the latest development version:

git clone https://github.com/mhofmann-Khoury/virtual_knitting_machine.git
cd knit_script
pip install -e .

Development with All Dependencies

For contributing to development:

git clone https://github.com/mhofmann-Khoury/virtual_knitting_machine.git
cd knit_script
pip install -e ".[dev]"
pre-commit install

This installs: - All runtime dependencies - Development tools (mypy, pytest, etc.) - Documentation generation tools - Pre-commit hooks for code quality