Metadata-Version: 2.5
Name: simcon-toolkit
Version: 0.5.0
Summary: Put a working Cadmould example project on your machine.
Author: SIMCON kunststofftechnische Software GmbH
License-Expression: Apache-2.0
Keywords: cadmould,injection-molding,scaffolding,simcon,simulation
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Requires-Dist: prompt-toolkit>=3.0.31
Description-Content-Type: text/markdown

# simcon-toolkit

Put a working SIMCON example project on your machine: a workflow you run, read and change,
with instruction files your own AI coding assistant already knows how to find.

```bash
uvx simcon-toolkit@latest init
```

It asks three questions: which template, what to call the folder, and whether you install
with uv or pip. Press Enter through all three for the defaults. Or answer them up front and
nothing is asked — only the template is required:

```bash
uvx simcon-toolkit@latest init my-study --template gate-study --package-manager uv
```

`@latest` is not decoration: without it uvx reuses whichever version it cached first.

At a terminal it draws the questions with the SIMCON wordmark and a rail down the left, and
if you say yes to signing in and installing, it shows each step live and ends with the
commands to run. Arrow keys or `j`/`k` move, Enter chooses, Tab takes the suggested folder
name, Esc or Ctrl-C cancels. It adapts to the terminal: full colour and Unicode where the
terminal has them, a plain Windows console gets the characters its font can draw, and these
switch the rest off:

- `--plain` asks in numbered lines with nothing redrawn, for a screen reader (automatic when
  `TERM=dumb`)
- `NO_COLOR=1` drops colour but keeps the layout
- `SIMCON_NO_MOTION=1` skips the animations; `SIMCON_GLYPHS=ascii` uses plain ASCII characters

Run without a terminal it asks nothing and prints plain lines, which is what an AI assistant
reads. With the template given as a flag at a terminal it asks only whether to sign in and
install, and otherwise prints the same plain lines.

**Without uv**, pipx or pip start it just the same:

```bash
pipx run simcon-toolkit init
```

or `pip install simcon-toolkit` into a virtual environment, then `simcon-toolkit init`. Every
command it prints afterwards uses the tool you started it with, so it never tells you to run
one you do not have. (pipx hands its runs to uv when uv is installed, and the commands then
name uv.) pipx runs on the Python it was installed with; if that is older than
3.12, name a newer one with `pipx run --python python3.12 simcon-toolkit init`.

See the templates, one line each:

```bash
uvx simcon-toolkit@latest init --list
```

Run it in a folder that already has files and it adds the project beside them. If a file it
would write already exists with different content, it stops and names the file before
changing anything; `--force` overwrites exactly those files and nothing else.

The installer needs no account. The project it writes does: it declares the licensed
`cadmould` SDK, and running it takes three browser sign-ins — one to install the SDK from
SIMCON's private index, one for your Cadmould licence, and one for the cloud. The project's
README walks through each, for the installer you chose.
