Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ workspace lifecycle, Pixi integration, and user-facing workflow commands.
- `manifest.py`: `arxproj.toml` parsing and rendering.
- `_toml.py`: TOML parser compatibility shim (`tomllib`/`tomli`).
- `pixi.py`: Pixi adapter and `pixi.toml` handling.
- `project.py`: project workflows (`init`, `add`, `install`, `build`, `run`).
- `project.py`: project workflows (`init`, `add`, `install`, `build`, `run`,
`pack`, `publish`).
- `doctor.py`: health checks for environment and manifest.
- `cli.py`: Typer command layer.

Expand All @@ -27,7 +28,10 @@ workspace lifecycle, Pixi integration, and user-facing workflow commands.
- `arxpm install`
- `arxpm add <name> [--path PATH|--git URL]`
- `arxpm build`
- `arxpm compile`
- `arxpm run`
- `arxpm pack`
- `arxpm publish`
- `arxpm doctor`

## Development
Expand Down
40 changes: 39 additions & 1 deletion docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ arxpm install
arxpm install --directory examples
```

Dependency entries are installed with pip inside the project pixi env:

- registry: `pip install <name>`
- path: `pip install <path>`
- git: `pip install git+<url>`

## `arxpm build`

Compile through Pixi using the configured compiler.
Expand All @@ -49,6 +55,16 @@ Current Arx invocation uses:
arx <entry> --output-file <out_dir>/<project_name>
```

## `arxpm compile`

Compile through Pixi using the configured compiler. This is a clearer alias for
`arxpm build` (which is kept for compatibility).

```bash
arxpm compile
arxpm compile --directory examples
```

## `arxpm run`

Build and then run the produced artifact through Pixi.
Expand All @@ -58,7 +74,29 @@ arxpm run
arxpm run --directory examples
```

Build/compiler output and the application stdout/stderr are streamed directly;
The command shows compiler and program output directly in your terminal.

## `arxpm pack`

Build package artifacts locally without uploading to a registry.

```bash
arxpm pack
arxpm pack --directory examples
```

## `arxpm publish`

Build and publish the current project as a Python package that bundles
`arxproj.toml` and `*.x`/`*.arx` sources.

```bash
export TWINE_USERNAME=__token__
export TWINE_PASSWORD=<pypi-token>
arxpm publish
arxpm publish --repository-url https://test.pypi.org/legacy/
arxpm publish --dry-run
```

## `arxpm doctor`

Expand Down
12 changes: 11 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The report should show:
- pixi available
- `arxproj.toml` found
- `pixi.toml` found
- `python` and `clang` declared in `pixi.toml`
- `python`, `pip`, and `clang` declared in `pixi.toml`

## Run Example

Expand All @@ -40,6 +40,16 @@ python -m arxpm build --directory examples
python -m arxpm run --directory examples
```

## Publish Package

Set Twine credentials for your package index (PyPI example):

```bash
export TWINE_USERNAME=__token__
export TWINE_PASSWORD=<pypi-token>
python -m arxpm publish --directory examples
```

## Local Quality Gates

```bash
Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ only for distributing `arxpm` itself.
- `src/arxpm/manifest.py`: parse/render `arxproj.toml`.
- `src/arxpm/_toml.py`: TOML parser compatibility shim (`tomllib`/`tomli`).
- `src/arxpm/pixi.py`: Pixi detection and partial `pixi.toml` sync.
- `src/arxpm/project.py`: `init`, `add`, `install`, `build`, `run`.
- `src/arxpm/project.py`: `init`, `add`, `install`, `build`, `run`, `pack`,
`publish`.
- `src/arxpm/doctor.py`: environment and manifest checks.
- `src/arxpm/cli.py`: Typer CLI layer.

Expand All @@ -34,7 +35,10 @@ arxpm init --name hello-arx
arxpm add http
arxpm install
arxpm build
arxpm compile
arxpm run
arxpm pack
arxpm publish
arxpm doctor
```

Expand Down
4 changes: 3 additions & 1 deletion docs/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,6 @@ mylib = { path = "../mylib" }
utils = { git = "https://example.com/utils.git" }
```

Version solving and registry resolution are intentionally out of scope in v0.
Version solving is intentionally out of scope in v0. During `arxpm install`,
registry dependencies are installed with `pip install <name>`, path dependencies
with `pip install <path>`, and git dependencies with `pip install git+<url>`.
2 changes: 1 addition & 1 deletion docs/pixi-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

`arxpm` does not own all of `pixi.toml`. It only manages:

- required toolchain dependencies (`python`, `clang`)
- required toolchain dependencies (`python`, `pip`, `clang`)
- the `tool.arxpm` section used to track managed fields

Unrelated user sections such as tasks and features are preserved.
Expand Down
3 changes: 0 additions & 3 deletions examples/arxproj.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ entry = "src/main.x"
out_dir = "build"

[dependencies]
http = { source = "registry" }
mylib = { path = "../mylib" }
utils = { git = "https://example.com/utils.git" }

[toolchain]
compiler = "arx"
Expand Down
1 change: 1 addition & 0 deletions examples/pixi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ platforms = ["linux-64", "osx-64", "win-64"]

[dependencies]
python = "*"
pip = "*"
clang = "*"
Loading
Loading