Metadata-Version: 2.4
Name: caifs
Version: 0.1.0
Summary: Python wrapper for the CAIFS cross-platform installer framework
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# caifs v0.1.0

Python wrapper for the [CAIFS](https://github.com/caifs-org/caifs) cross-platform installer framework.

## Install

From PyPI (once published):

```bash
uv tool install caifs
```

From GitHub release:

```bash
uv tool install caifs --from "https://github.com/caifs-org/caifs-pypi/releases/latest/download/caifs-0.1.0-py3-none-any.whl"
```

### Try in Docker

Note: we also have OCI native ways of getting caifs into containers using scratch images.

```bash
docker run --rm -it python:3.13-slim bash -c '
  pip install uv &&
  uv tool install caifs --from "https://github.com/caifs-org/caifs-pypi/releases/latest/download/caifs-0.1.0-py3-none-any.whl" &&
  export PATH="$HOME/.local/bin:$PATH" &&
  caifs status
'
```

## Usage

```bash
caifs status          # Show available targets
caifs add <target>    # Install a target
caifs rm <target>     # Remove a target
```

## Development

```bash
uv sync                  # Install dependencies
just vendor              # Download caifs + caifs-common into _vendor/
uv run caifs --version   # Verify it works
just test                # Run tests
just pre-commit-run      # Lint and format
```
