README.md

---
title: NCAkit
emoji: 🎬
colorFrom: purple
colorTo: blue
sdk: docker
app_port: 8880
pinned: false
license: mit
Api Docs: https://robiul487-NCAkit.hf.space/docs
---

# NCAkit - Neural Content Automation Toolkit 🤖

A modular Python toolkit for content automation, featuring video creation, AI story reels, and more.

## ✨ Features

- 🎬 **Video Creator** - Short-form videos with TTS, captions, and music
- � **Story Reels** - AI-powered character-consistent story videos (NEW!)
- �🔌 **Modular Architecture** - Easy to add new features
- 🌐 **REST API** - FastAPI with auto-generated docs
- 🚀 **Ready for Deployment** - Docker & Hugging Face Spaces

## 🏗️ Project Structure

```
NCAkit/
├── app.py                      # Main FastAPI application
├── config.py                   # Unified configuration
├── requirements.txt            # All dependencies
├── Dockerfile                  # Docker deployment
│
├── core/                       # Shared infrastructure
│   ├── module_registry.py      # Auto module discovery
│   └── utils/                  # Shared utilities
│
├── modules/                    # Feature modules
│   ├── video_creator/          # Video creation module
│   ├── story_reels/            # AI Story Reels (NEW!)
│   └── _template/              # Template for new modules
│
└── static/                     # Web UI & assets
```

## 🚀 Quick Start

### Install

```bash
cd NCAkit
pip install -r requirements.txt
```

### Configure

```bash
cp .env.example .env
# Edit .env with your API keys
```

### Run

```bash
python app.py
# Or: uvicorn app:app --host 0.0.0.0 --port 8880 --reload
```

### Access

- **Web UI**: http://localhost:8880
- **API Docs**: http://localhost:8880/docs
- **Modules**: http://localhost:8880/api/modules

## 📡 API Endpoints

### Video Creator
| Endpoint | Method | Description |
|----------|--------|-------------|
| `/api/video/short-video` | POST | Create video |
| `/api/video/short-video/{id}/status` | GET | Check status |
| `/api/video/short-video/{id}` | GET | Download video |

### Story Reels (NEW!)
| Endpoint | Method | Description |
|----------|--------|-------------|
| `/api/story-reels/generate` | POST | Generate AI story video |
| `/api/story-reels/status/{id}` | GET | Check status |
| `/api/story-reels/download/{id}` | GET | Download video |

## ⚙️ Environment Variables

| Variable | Required | Module |
|----------|----------|--------|
| `PEXELS_API_KEY` | ✅ | Video Creator |
| `HF_TTS` | ✅ | Video Creator / Story Reels |
| `NVIDIA_API_KEY` | ✅ | Story Reels (Primary) |
| `CF_URL` | ❌ | Story Reels (Fallback) |
| `CF_API` | ❌ | Story Reels (Fallback) |
| `GEMINI_API_KEY` | ✅ | Story Reels (AI Scripts) |

## 🐳 Docker

```bash
docker build -t ncakit .
docker run -p 8880:8880 --env-file .env ncakit
```

## 📄 License

MIT