diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index ee20934..b6f160c 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -12,6 +12,10 @@ jobs: - uses: actions/checkout@v4 - name: Install validation dependencies run: python3 -m pip install -r requirements-dev.txt + - name: Install CLI package + run: python3 -m pip install -e . + - name: Check installed CLI + run: aicp --version && aicp --help - name: Validate JSON and local Markdown links run: python3 scripts/validate.py - name: Validate contracts diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index ec26083..ada40e6 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -1,5 +1,10 @@ # Getting started +## Optional CLI installation + +From a playbook checkout with Python 3.10+, run `python3 -m pip install -e .` (preferably inside a virtual environment). This installs the `aicp` command so you can run `aicp --help`, `aicp init`, and `aicp verify` from other working directories. Installation does not install or authenticate any vendor coding assistant. The checkout-based `python3 -m aicp` commands below remain supported. This project is not yet published to a package index. + + For a complete worked example, see the [practical walkthrough](PRACTICAL_WALKTHROUGH.md). For additional fictional scenarios and privacy guidance, see the [usage guide](USAGE_GUIDE.md). ## Quick setup diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d18a9a1 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,24 @@ +[build-system] +requires = ["setuptools>=68"] +build-backend = "setuptools.build_meta" + +[project] +name = "ai-coding-playbook" +version = "0.1.0" +description = "Engineering-first task, onboarding, and verification CLI for AI-assisted coding" +readme = "README.md" +requires-python = ">=3.10" +license = "Apache-2.0" +authors = [{name = "AI Coding Playbook contributors"}] +keywords = ["coding-assistants", "developer-tools", "verification"] +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", +] +dependencies = [] + +[project.scripts] +aicp = "aicp.__main__:main" + +[tool.setuptools] +packages = ["aicp"]