# miaoma

**Repository Path**: tianyuanoss/miaoma

## Basic Information

- **Project Name**: miaoma
- **Description**: 妙码（MiaoMa）是一款全新的全栈代码自动生成工具，以数据库表结构为核心，通过多语言、多框架的映射转换和模板渲染，实现从数据库设计到代码开发的一站式自动化流程。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.miaoma.com
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2025-06-18
- **Last Updated**: 2026-01-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 妙码（MiaoMa）- 妙码生花

[![PyPI version](https://badge.fury.io/py/miaoma.svg)](https://badge.fury.io/py/miaoma)
[![Python Version](https://img.shields.io/pypi/pyversions/miaoma.svg)](https://pypi.org/project/miaoma/)
[![Documentation Status](https://readthedocs.org/projects/miaoma/badge/?version=latest)](https://miaoma.readthedocs.io/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> 妙若天成，码到成功
>
> 美妙绝伦，妙不可言

妙码（MiaoMa）寓意"妙码生花"，体现了我们对代码生成的独特理念：
- **妙**：代表奇妙变化、创造性思维，像魔法一般将简单转化为精彩
  - 美妙：优雅的设计，精致的实现
  - 奇妙：AI驱动的创造力，无限的可能性
  - 幻妙：变幻莫测的创造过程，如梦似幻的代码魔法
  - 妙不可言：超越传统的边界，创造令人惊叹的代码艺术
- **码**：象征代码的严谨、技术的准确，以工程化方法保证质量

我们相信：
- 代码生成不仅是机械的转换，更是充满创造性的过程
- 技术既要有想象力，也要保持严谨性
- AI的创造力是无限的，能带来妙不可言的惊喜
- 简单的描述，经过幻妙的转化，绽放出绚丽的代码之花

妙码（MiaoMa）是一款全新的全栈代码自动生成工具，以数据库表结构为核心，通过多语言、多框架的映射转换和模板渲染，实现从数据库设计到代码开发的一站式自动化流程。

## 特性

- 🚀 **文档 + 测试 + AI驱动**：文档先行，测试保障，AI赋能
- 🎯 **AI First设计**：目录即语义，注释即文档，代码即意图
- ⚙️ **配置驱动**：统一的配置结构，多语言多框架支持
- 🔄 **代码分层**：自动生成层、自定义层、共享层
- 📦 **增量更新**：智能代码合并，自定义代码保护

## 安装

```bash
pip install miaoma
```

## 快速开始

1. **解析SQL**
```bash
python miaoma.py parse-sql t_miaoma_student
```

2. **生成配置**
```bash
python miaoma.py gen-config t_miaoma_student
```

3. **生成代码**
```bash
python miaoma.py gen-code t_miaoma_student --template springboot3
```

## 文档

详细文档请访问：[妙码文档中心](https://docs.miaoma.com)

## 支持的技术栈

### 后端框架
- Java + Spring Boot
- Node.js + Express
- Python + FastAPI

### 前端框架
- TypeScript + Vue3
- React + Ant Design
- Angular + Material

### 数据库
- MySQL
- PostgreSQL

## 开发

1. **克隆代码**
```bash
git clone https://github.com/miaoma/miaoma.git
cd miaoma
```

2. **安装依赖**
```bash
pip install -r requirements.txt
pip install -r requirements-dev.txt
```

3. **运行测试**
```bash
# 运行所有测试
python3 -m pytest

# 运行特定目录的测试
python3 -m pytest tests/cases/sql/ -v

# 运行单个测试文件
python3 -m pytest tests/cases/sql/test_preprocess_sql.py
```

4. **运行示例**
```bash
pip3 install -r requirements.txt --break-system-packages
python3 miaoma.py gen-project --project assets/projects/default --directory assets/projects/default/sql
python3 miaoma.py gen-project --project assets/projects/anypay --directory assets/projects/anypay/sql
```

## 贡献

我们欢迎任何形式的贡献，包括但不限于：
- 提交问题和建议
- 改进文档
- 提交代码
- 分享使用经验

详细信息请参考[贡献指南](CONTRIBUTING.md)。

## 社区

- [官方网站](https://miaoma.com)
- [技术文档](https://docs.miaoma.com)
- [社区论坛](https://community.miaoma.com)
- [问答中心](https://ask.miaoma.com)
- [模板市场](https://market.miaoma.com)

## 许可证

本项目采用 [MIT 许可证](LICENSE)。

## 致谢

感谢所有为项目做出贡献的开发者！