Metadata-Version: 2.4
Name: builddrone
Version: 0.3.3
Summary: Modular build framework
Author: Andreas Sekulski
Project-URL: Homepage, https://github.com/Nepitwin/Builddrone
Project-URL: Documentation, https://nepitwin.github.io/Builddrone/latest/
Project-URL: Repository, https://github.com/Nepitwin/Builddrone
Project-URL: PyPI, https://pypi.org/project/builddrone/
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mike; extra == "docs"

# Builddrone

<table>
  <tr>
    <td rowspan="2" valign="middle">
      <img src="https://raw.githubusercontent.com/Nepitwin/Builddrone/main/logo.png" alt="Builddrone" width="200" height="200">
    </td>
    <td><strong>Project</strong></td>
    <td><a href="https://github.com/Nepitwin/Builddrone">GitHub</a> · <a href="https://pypi.org/project/builddrone/">PyPI</a> · <a href="https://nepitwin.github.io/Builddrone/latest/">Documentation</a></td>
  </tr>
  <tr>
    <td><strong>Environment</strong></td>
    <td>
      <a href="https://pypi.org/project/builddrone/"><img src="https://img.shields.io/pypi/v/builddrone.svg" alt="PyPI version"></a>
      <a href="https://github.com/Nepitwin/Builddrone/actions/workflows/workflow.yml"><img src="https://github.com/Nepitwin/Builddrone/actions/workflows/workflow.yml/badge.svg" alt="Tests"></a>
    </td>
  </tr>
</table>

Builddrone is a JSON-driven build orchestration framework and command-line
interface for Python projects. A pipeline is made up of named stages, and each
stage executes an ordered list of registered modules.

## Documentation

Full documentation is published on GitHub Pages:

**https://nepitwin.github.io/Builddrone/latest/**

Each release tag gets its own documentation version. Use the version selector
on the site to read docs for a specific release; `latest` always points at the
most recent release.

Topics covered there include installation, blueprint format, CLI usage, all
built-in modules, examples, and custom module development.

## Quick start

Install from PyPI, create a `blueprint.json`, and run a stage:

```bash
python -m pip install builddrone
python -m builddrone build
```

For local development:

```bash
python -m pip install -e ".[dev]"
```

Builddrone requires Python 3.8 or newer.

## License

MIT License
