Metadata-Version: 2.1
Name: cook_builder
Version: 0.2.2
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: Documentation, https://serweryn617.github.io/cook-docs/
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/x-rst
License-File: LICENSE

****
Cook
****

Local and remote shell commands executor written and configured in Python

Documentation
=============

Checkout `cook-docs <https://serweryn617.github.io/cook-docs/>`_ GitHub Pages!

Quickstart
==========

Installation
------------

Cook is available on PyPI as `cook-builder <https://pypi.org/project/cook-builder/>`_
The recommended way is to install it using `pipx <https://pipx.pypa.io/stable/>`_:

.. code-block:: bash

   pipx install cook-builder

Generating recipe template
--------------------------

Cook uses ``recipe.py`` files to store project configuration.

To generate a recipe template for your project run:

.. code-block:: bash

   cook -t

You can open the created ``recipe.py`` file and adjust the projects/commands to your needs.

Running Cook
------------

Simply use ``cook`` command to run the recipe file.

.. code-block:: bash

   cook

To see all available command line options use ``cook --help``.
