Metadata-Version: 2.4
Name: fabricatio-yue
Version: 0.2.12
Summary: An extension of fabricatio, provide capability to compose lyrics that can be used in music generation with YuE.
Project-URL: Homepage, https://github.com/Whth/fabricatio
Project-URL: Repository, https://github.com/Whth/fabricatio
Project-URL: Issues, https://github.com/Whth/fabricatio/issues
Author-email: Whth <zettainspector@foxmail.com>
License: MIT License
        
        Copyright (c) 2025 Whth Yotta
        
        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.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: <3.15,>=3.12
Requires-Dist: fabricatio-core
Requires-Dist: more-itertools>=10.7.0
Requires-Dist: orjson>=3.11.4
Requires-Dist: pydantic>=2.11.5
Provides-Extra: cli
Requires-Dist: questionary>=2.1.0; extra == 'cli'
Requires-Dist: typer-slim[standard]>=0.15.2; extra == 'cli'
Description-Content-Type: text/markdown

# `fabricatio-yue`

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
![Python Versions](https://img.shields.io/pypi/pyversions/fabricatio-yue)
[![PyPI Version](https://img.shields.io/pypi/v/fabricatio-yue)](https://pypi.org/project/fabricatio-yue/)
[![PyPI Downloads](https://static.pepy.tech/badge/fabricatio-yue/week)](https://pepy.tech/projects/fabricatio-yue)
[![PyPI Downloads](https://static.pepy.tech/badge/fabricatio-yue)](https://pepy.tech/projects/fabricatio-yue)
[![Build Tool: uv](https://img.shields.io/badge/built%20with-uv%20%2B%20maturin-orange)](https://github.com/astral-sh/uv)

An extension of fabricatio, which provides capability to compose lyrics that can be used in music generation with YuE.

---

## 📦 Installation

This package is part of the `fabricatio` monorepo and can be installed as an optional dependency using either pip or uv:

```bash
pip install fabricatio[yue]
# or
uv pip install fabricatio[yue]
```

For a full installation that includes this package and all other components of `fabricatio`:

```bash
pip install fabricatio[full]
# or
uv pip install fabricatio[full]
```

## 🔍 Overview

Provides AI-powered lyrics composition capabilities specifically designed for music generation with YuE, enabling the
creation of structured song lyrics with genre-specific characteristics and musical compatibility. It integrates genre
selection with intelligent lyric generation for seamless music production workflows.

## 🧩 Key Features

- **Intelligent Genre Selection**: Automatic genre detection and selection based on requirements for contextually
  appropriate lyrics
- **Structured Lyric Generation**: AI-powered creation of song lyrics with proper structure, rhyme schemes, and musical
  flow
- **Batch Processing**: Support for generating multiple song lyrics simultaneously for efficient content creation
- **YuE Integration**: Specifically designed for compatibility with YuE music generation systems
- **Template-Driven Composition**: Configurable templates for consistent and high-quality lyric generation
- **Requirement-Based Creation**: Flexible system that adapts to various musical themes, moods, and styles

## 🔗 Dependencies

Core dependencies:

- `fabricatio-core` - Core interfaces and utilities

No additional dependencies required.

## 📄 License

MIT – see [LICENSE](../../LICENSE)

