Metadata-Version: 2.4
Name: arxpm
Version: 1.3.0
Summary: Project and package manager for Arx workspaces
License: BSD 3-Clause License
         
         Copyright (c) 2026, ARX
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         1. Redistributions of source code must retain the above copyright notice, this
            list of conditions and the following disclaimer.
         
         2. Redistributions in binary form must reproduce the above copyright notice,
            this list of conditions and the following disclaimer in the documentation
            and/or other materials provided with the distribution.
         
         3. Neither the name of the copyright holder nor the names of its
            contributors may be used to endorse or promote products derived from
            this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Author: Ivan Ogasawara
Requires-Python: >=3.10,<4
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: arxlang (>=0.5.0)
Requires-Dist: build (>=1.2.0)
Requires-Dist: tomli (>=2.0.1) ; python_version < "3.11"
Requires-Dist: twine (>=6.2.0)
Requires-Dist: typer (>=0.12.3,<1.0.0)
Requires-Dist: uv (>=0.5.0)
Description-Content-Type: text/markdown

# arxpm

`arxpm` is the Arx project manager and workspace tool.

`arx` stays compiler-only. `arxpm` owns project manifests (`.arxproject.toml`),
workspace lifecycle, Python environment provisioning (via `uv`), and user-facing
workflow commands.

## Compatibility

- Python 3.10+ is supported.
- On Python 3.10, `arxpm` uses `tomli` as a compatibility fallback for
  `tomllib`.

## Architecture

- `models.py`: typed manifest models.
- `manifest.py`: `.arxproject.toml` parsing and rendering.
- `_toml.py`: TOML parser compatibility shim (`tomllib`/`tomli`).
- `environment.py`: backend-neutral environment protocol plus managed-venv,
  existing-venv, and conda implementations that install packages via
  `uv pip install --python <interp>`.
- `project.py`: project workflows (`init`, `add`, `install`, `build`, `run`,
  `pack`, `publish`).
- `healthcheck.py`: health checks for environment and manifest.
- `cli.py`: Typer command layer.

## Commands (v0)

- `arxpm init`
- `arxpm install`
- `arxpm add <name> [--path PATH|--git URL]`
- `arxpm build`
- `arxpm compile`
- `arxpm run`
- `arxpm pack`
- `arxpm publish`
- `arxpm healthcheck`

## Development

```bash
mamba env create --file conda/dev.yaml
conda activate arxpm
poetry install --with dev
pytest
```

The `examples/` directory ships several sample projects:

- `examples/hello-arx/` — minimal single-file project.
- `examples/multi-module/` — multi-file project whose `main.x` imports and calls
  functions from sibling `.x` modules. See the
  [Multi-file Projects](docs/multi-file-projects.md) guide.
- `examples/local_lib/` + `examples/local-consumer/` — a library and a consumer
  that live side by side on disk so the consumer resolves imports against the
  library's `.x` files. See [Local Packages](docs/local-packages.md) for the
  supported layout and the current boundary around installed libraries.

Integration tests that compile and execute the examples live in
`tests/test_examples_integration.py` and are gated on `arx` and `uv` being on
`PATH`. Run them with:

```bash
pytest -m integration
```

