Metadata-Version: 2.5
Name: bricoler
Version: 0.2.1
Summary: utility for running FreeBSD src development workflows
Project-URL: Documentation, https://github.com/markjdb/bricoler#readme
Project-URL: Issues, https://github.com/markjdb/bricoler/issues
Project-URL: Source, https://github.com/markjdb/bricoler
Author-email: Mark Johnston <markj@FreeBSD.org>
License-Expression: BSD-2-Clause
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: pexpect
Description-Content-Type: text/markdown

# bricoler

bricoler is a utility for running FreeBSD src development workflows.
The basic idea is to simplify common src development tasks by provding a framework to wrap operations like:
- building a FreeBSD src tree,
- constructing a VM image from the output of a build,
- booting the VM image (using QEMU or bhyve),
- running things in the guest once it has booted.

-----

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Installation

Make sure that Python 3, hatch and other dependencies are installed:

```sh
py="py$(pkg rall-depends python3 | sed -e s/^python// -e 's/-.*$//')"
pkg install python3 "$py-hatch" "$py-pip" "$py-sqlite3"
```

Run `hatch build` from the root of the repository.
Install it locally with:

```sh
pip install dist/bricoler-0.2.1-py3-none-any.whl
```

This will install it to `~/.local/bin`, so make sure that is in your PATH.
There is a bricoler man page, so you can run `man bricoler` to get usage information and examples.

If you use bash and have `bash-completion` installed, this will also install a completion script to `~/.local/share/bash-completion/completions/bricoler`.
I find this very very useful.
If you use a different shell, please try adding a completion script for it and submit a PR.

Installing ccache is recommended, it will be used automatically.

## Usage

Example:

```sh
bricoler freebsd-regression-test-suite \
    --freebsd-regression-test-suite/memory=8192 \
    --freebsd-regression-test-suite/ncpus=8 \
    --freebsd-regression-test-suite/tests="sys/netpfil/pf sbin/pfctl" \
    --freebsd-src-git-checkout/url=/usr/src \
    --freebsd-src-build/kernel_config=GENERIC-KASAN
```

More extensive usage information can be found in the man page `man share/bricoler.1`.

## License

`bricoler` is distributed under the terms of the [BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause.html) license.
