Skip to content

quickstart.md

Latest commit

 

History

History
58 lines (38 loc) · 1.07 KB

quickstart.md

File metadata and controls

58 lines (38 loc) · 1.07 KB
Raw

Quickstart

1) Create your project from this template

Replace all placeholders:

  • ap-python-starter-kit
  • ap_python_starter_kit
  • Python starter kit
  • Template Maintainers

Or use the convenience script:

python3 scripts/rename_project.py

(Non-interactive usage is also supported; run python3 scripts/rename_project.py -h to see options.)

2) Install dependencies

uv sync

3) Run the app in CLI mode

By default the launcher runs an ACSys demo query and prints a few readings:

uv run ap-python-starter-kit

Override the device/request string:

uv run ap-python-starter-kit --device "G:SCTIME@P,15H"

The default launcher behavior is the CLI path.

4) Optional: enable the integrated PyQt GUI

The GUI uses the same shared ACSys client layer and shows a live ACSys reading.

uv sync --extra gui-pyqt
uv run ap-python-starter-kit --gui

You can combine --gui with --device to point the GUI at a different ACSys device/request string.

5) Run tests and lint

uv run pytest
uv run ruff check .