Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willwoodward/woodwork-engine
An experiment to determine the use of IaC applied to the AI Agentic workflows.
https://github.com/willwoodward/woodwork-engine
Last synced: 3 days ago
JSON representation
An experiment to determine the use of IaC applied to the AI Agentic workflows.
- Host: GitHub
- URL: https://github.com/willwoodward/woodwork-engine
- Owner: willwoodward
- Created: 2024-08-14T19:30:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T15:14:24.000Z (2 months ago)
- Last Synced: 2024-10-29T15:57:14.689Z (2 months ago)
- Language: Python
- Size: 176 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome_ai_agents - Woodwork-Engine - An AI Agent IaC tool that aims to make developing and deploying AI Agents easier. (Building / Deployment)
README
[](https://pypi.org/project/woodwork-engine/)
[](https://pypi.org/project/woodwork-engine/)
[](https://pypi.org/project/woodwork-engine/)
[](https://github.com/willwoodward/woodwork-engine/releases)
[](https://github.com/willwoodward/woodwork-engine/blob/main/LICENSE)
[](https://github.com/willwoodward/woodwork-engine/stargazers)
# woodwork-engine
Welcome to woodwork-engine, an AI Agent IaC tool that aims to make developing and deploying AI Agents easier.
Through defining components in a configuration language, an LLM will decompose the task into actionable steps, which can be executed using the supplied tools. We use latest research to inform design decisions, and we implement this as most of the setup is copy/paste across projects. Through only focussing on the necessary components of a system, this package should make designing custom, vertical agents much easier.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
## Features
- A custom config language, woodwork (.ww files), allowing agent components to be declared
- Integrations and communication between components are handled
- Additional customisation or extension can be provided by implementing some of our interfaces
A [roadmap](https://github.com/willwoodward/woodwork-meta/blob/main/ROADMAP.md) is provided with details on future features.
## Installation
1. **Run `pip install woodwork-engine`**: This gives access to the `woodwork` CLI tool, along with the ability to parse and deploy AI Agent components from .ww files
2. **Install the Woodwork extension on VSCode if relevant**: This provides syntax highlighting and intellisense for code in .ww files
## Usage
1. **Create a main.ww file and write some code**: This file is where component declarations are read from. For some inspiration, consult the examples
2. **Run `woodwork init`**: This installs the necessary dependencies to run your components
3. **Run `woodwork`**: This activates the components
## Examples
For some examples, consult the examples folder. ENV variables are denotes by a '$', place a .env file in the same directory as the main.ww file and populate it with the necessary variables.
## Contributing
To view the contributing guide for woodwork, the [CONTRIBUTING.md](https://github.com/willwoodward/woodwork-meta/blob/main/CONTRIBUTING.md) file in the meta repository contains more information. We would love your help! Additionally, if you prefer working on other projects aligned with language servers or web development, [woodwork-language](https://github.com/willwoodward/woodwork-language) and [woodwork-website](https://github.com/willwoodward/woodwork-website) could be worth taking a look at.
## License
woodwork-engine uses a GPL license, which can be read in full [here](./LICENSE).