Metadata-Version: 2.4
Name: substrate-setup
Version: 0.2.2
Summary: One-shot local configurator for coding agents against a Substrate gateway
Project-URL: Homepage, https://github.com/FrankXiaA/substrate-solutions
Project-URL: Source, https://github.com/FrankXiaA/substrate-solutions/tree/main/substrate-api/substrate_setup
Project-URL: Issues, https://github.com/FrankXiaA/substrate-solutions/issues
Author: Substrate Solutions
License: MIT
Keywords: aider,continue,gateway,hermes,llm,openai-compatible,substrate
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: httpx>=0.27
Requires-Dist: ruamel-yaml>=0.18
Provides-Extra: dev
Requires-Dist: mypy<2,>=1.13; extra == 'dev'
Requires-Dist: pytest-httpx>=0.30; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff<1,>=0.7; extra == 'dev'
Description-Content-Type: text/markdown

# substrate-setup

One-shot configurator that points local coding agents at a Substrate gateway.

## Install

`substrate-setup` requires Python 3.12+. The installers below pick the right interpreter automatically — you don't need a Python 3.12 already on your machine:

```bash
# Option A — uv (recommended; downloads Python 3.12 on demand if missing)
uv tool install substrate-setup

# Option B — pipx
pipx install substrate-setup
```

Don't have `uv`? Install it once with:

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh   # macOS / Linux
# or on Windows:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

> **Why not `pip install substrate-setup`?** It works only if the `pip` on your PATH is bound to a Python 3.12+ interpreter. Anaconda's default `pip` (Python 3.9) is the common pitfall — PyPI hides every release from it with `Requires-Python >=3.12` and the error message is unhelpful. `uv` and `pipx` both create an isolated 3.12 venv for the tool, so they sidestep the issue entirely.

## Use

```bash
export SUBSTRATE_API_KEY="sk-substrate-..."   # or be prompted

substrate-setup configure          # detect installed agents and wire them up
substrate-setup verify             # read-only: confirm everything points at the gateway
substrate-setup remove             # strip the substrate-managed entries
substrate-setup --help
```

Supported agents: `hermes`, `cursor`, `aider`, `continue`.

Subset with `--agents-only hermes,aider`. Preview without writing: `--dry-run`. Override the gateway base URL: `--base-url https://your-gateway.example.com`.
