Install policy

Install And CLI Tool Policy

This document defines the public install pattern for EasyEDA Monkey and the workspace-install pattern that downstream repos should copy for command-line Python tools.

Public CLI Install

Users who want the command-line tool should install it with uv tool install. This creates an isolated tool environment, installs the console script, and avoids mixing application dependencies with a project virtual environment.

uv tool install easyeda-monkey
uv tool update-shell
easyeda-monkey --version

Library Install

Users who are writing Python code against the parser APIs should install the package into their chosen Python environment.

pip install easyeda-monkey

Development Install

Contributors should use uv for dependency sync, test runs, package builds, and editable CLI install tests.

uv sync --extra test
uv run --extra test rack run --all
uv tool install --force --editable .
easyeda-monkey --version

Workspace Installer Pattern

Workspace setup and update scripts should install released CLI tools with pinned versions and verify the generated executable.

uv tool install --force easyeda-monkey==2026.5.26
uv tool update-shell
easyeda-monkey --version

During source development, a workspace may temporarily replace the released package with an editable checkout.

uv tool install --force --editable C:\path\to\easyeda_monkey

Packaging Boundary

Pure Python packages should keep standard PyPA build output in a flat dist/ folder. Per-platform artifact folders are reserved for packages that build native wheels or platform-specific binaries.

Tools in this package family should minimize external dependencies. New runtime, optional, and test-only dependencies need explicit justification before they are accepted.

PyInstaller and Nuitka are deferred until there is a clear no-Python or offline installer requirement. The default public path remains a normal Python package with console scripts.