NCAkit / README.md
robiul487's picture
Update README.md
2016e6e verified
metadata
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

cd NCAkit
pip install -r requirements.txt

Configure

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

Run

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

Access

πŸ“‘ 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

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

πŸ“„ License

MIT