Metadata-Version: 2.4
Name: pyjinx-installer
Version: 0.1.0
Summary: PyJinx project creator
Requires-Python: <4.0,>=3.10
Description-Content-Type: text/markdown

# PyJinx Installer

> **Temporary project names:** this installer and the `pyjinx` command use the
> PyJinx name while the project is being established. The planned long-term
> framework and installer name is **Veyra**; naming will be updated in a future
> coordinated release.

The global installer creates a new application from the private
[`pyjinx/starter`](https://github.com/pyjinx/starter) repository. It removes the
starter's development checkout and local framework copy, then leaves the
application configured to install the `pyjinx` framework distribution from
PyPI.

## Installation

Install from a checked-out copy with uv:

```console
uv tool install .
```

For local development, install the package into the active environment instead:

```console
uv pip install .
```

The installation provides the global `pyjinx` command.

## Create an application

```console
pyjinx new hello-world
cd hello-world
uv sync
```

The command refuses to populate a non-empty destination. Project names must be
one safe directory name made from letters, numbers, `-`, and `_`, beginning with
a letter.

For local starter development or tests, pass a directory explicitly:

```console
pyjinx new hello-world --starter-path /path/to/starter
```

The `PYJINX_STARTER_REPOSITORY` environment variable can also select a starter
repository (or local directory). If neither option is supplied, the default
source is `https://github.com/pyjinx/starter.git`.
