Metadata-Version: 2.1
Name: cook_builder
Version: 0.1.1
Summary: Build script aggregator and remote executor
Author: Seweryn Rusecki
License: MIT License
        
        Copyright (c) 2024 Seweryn Rusecki
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/serweryn617/cook
Project-URL: Issues, https://github.com/serweryn617/cook/issues
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fabric==3.2.2
Requires-Dist: rich==13.7.1

# Cook

Build script aggregator and remote executor.

# Getting started

### Install cook with pipx

Cook is available on PyPI under the name [cook-builder](https://pypi.org/project/cook-builder/).
It can be easily installed with pip, but the recommended method is to use [pipx](https://pipx.pypa.io/stable/).

```sh
pipx install cook-builder
```

### Setup

Create `recipe.py` file which describes how to build Your project locally and on remote build servers.

See the [example project](example).

### Run

Run `cook` command in the terminal and see how the project is being built!

# Development

### Install cook from source

```sh
git clone https://github.com/serweryn617/cook.git
cd cook
pip install -e .
```

<!-- RELEASING
1. Update version in pyproject.toml
2. Build and upload wheels to PyPI:
    python3 -m build
    twine upload dist/*
-->

<!-- TODO: add tests -->
