Metadata-Version: 2.4
Name: sheave
Version: 0.1.0
Summary: Presets for guiding agentic AI workflows
License: # Custom Notice
         This repository is licensed under the MIT License **with additional terms**
         restricting AI/ML training use. See the “Additional Terms – Apathetic No-AI Use
         Rider v1.0 or later” section at the end of this file for details.
         
         ------------------------------------------------------------
         
         MIT License
         
         Copyright (c) 2025 Apathetic Tools
         
         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.
         
         -----------------------------------------------------------------------
         Additional Terms – Apathetic No-AI Use Rider v1 or later, 2025-11-09
         -----------------------------------------------------------------------
         
         In addition to the permissions and conditions of the Base License:
         
         1. You may **not** use this repository, in whole or in part, including its source
            code or derivatives, to train, fine-tune, or otherwise improve any
            machine-learning or artificial-intelligence system.
         
         2. You may **not** include this repository or its contents in any dataset or
            corpus used for AI/ML training, nor provide automated access to it for that
            purpose.
         
         3. These restrictions apply to both commercial and non-commercial use.
         
         4. This Rider is **Version 1 or later**, as published by the **Apathetic License
            Collective**. You may use this version or any later version, which may modify,
            replace, or entirely remove these restrictions. The canonical source for the
            latest version is: [https://github.com/apathetic-license/apathetic-noai](https://
            github.com/apathetic-license/apathetic-noai)
         
         
         Alternative licensing terms may be available directly from the author.
License-File: LICENSE
Keywords: ai,agent,workflow
Author: Apathetic Tools
Requires-Python: >=3.10
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Build Tools
Requires-Dist: apathetic-logging (>=0.0.1,<2.0.0)
Requires-Dist: apathetic-schema (>=0.0.1,<2.0.0)
Requires-Dist: apathetic-utils (>=0.0.1,<2.0.0)
Project-URL: Changelog, https://github.com/apathetic-tools/sheave/releases
Project-URL: Documentation, https://apathetic-tools.github.io/sheave/
Project-URL: Homepage, https://github.com/apathetic-tools/sheave
Project-URL: Issues, https://github.com/apathetic-tools/sheave/issues
Project-URL: Repository, https://github.com/apathetic-tools/sheave
Description-Content-Type: text/markdown

# Sheave 🧭 


[![CI](https://github.com/apathetic-tools/sheave/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/apathetic-tools/sheave/actions/workflows/ci.yml)
[![License: MIT-aNOAI](https://img.shields.io/badge/License-MIT--aNOAI-blueviolet.svg)](LICENSE)
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/PW6GahZ7)

**Presets for guiding agentic AI workflows.**  
*Because tasks shouldn't get lost in translation.*

📘 **[Roadmap](./ROADMAP.md)** · 📝 **[Release Notes](https://github.com/apathetic-tools/sheave/releases)**

> [!NOTE]
> Heads up: the AI cooked dinner. It's edible, but watch your step. Detailed bug reports welcome.

## 🚀 Quick Start

Sheave provides preset rules, workflows, and commands for AI-powered IDE integrations like Cursor, Claude Desktop, and similar tools. These presets can be selectively enabled, similar to how you configure linter rules.

### Installation

```bash
# Using poetry
poetry add sheave

# Using pip
pip install sheave
```

### Basic Usage

```bash
# Enable specific presets (coming soon)
sheave enable --rules code-quality --workflows testing

# List available presets
sheave list

# Apply presets to your project
sheave sync
```

---

## 🎯 What is Sheave?

Sheave offers a curated collection of AI guidance presets that you can selectively enable:

- **Preset Rules**: Pre-configured prompt rules that get added to each AI interaction
  - Code quality standards
  - Testing best practices
  - Documentation guidelines
  - Security considerations

- **Preset Workflows**: Common workflows you can point an AI assistant to
  - Setting up new features
  - Refactoring patterns
  - Debugging strategies
  - Code review checklists

- **Preset Commands**: Ready-to-use commands for common development tasks
  - Generate test files
  - Create documentation
  - Run code quality checks
  - Format and lint code

All of these leverage functionality that already exists in your IDE — Sheave just provides a well-organized, selective set of presets you can opt into, similar to how ruff lets you choose which linting rules to enable.

## ✨ Features

- 🎯 **Selective presets** — Choose only the rules, workflows, and commands you need
- 🔌 **IDE integration** — Works with Cursor, Claude Desktop, and similar tools
- 📦 **Zero dependencies** — Lightweight and focused
- 🧩 **Modular** — Enable or disable presets independently
- 🔧 **Configurable** — Customize presets to match your project's needs

---

## ⚖️ License

- [MIT-aNOAI License](LICENSE)

You're free to use, copy, and modify the script under the standard MIT terms.  
The additional rider simply requests that this project not be used to train or fine-tune AI/ML systems until the author deems fair compensation frameworks exist.  
Normal use, packaging, and redistribution for human developers are unaffected.

## 🪶 Summary

**Use it. Hack it. Ship it.**  
It's MIT-licensed, minimal, and meant to stay out of your way — just with one polite request: don't feed it to the AIs (yet).

---

> ✨ *AI was used to help draft language, formatting, and code — plus we just love em dashes.*

<p align="center">
  <sub>😐 <a href="https://apathetic-tools.github.io/">Apathetic Tools</a> © <a href="./LICENSE">MIT-aNOAI</a></sub>
</p>

