Commit Β·
fa5c7f4
1
Parent(s): 7fa9d90
Add HF Spaces metadata and update README
Browse files
README.md
CHANGED
|
@@ -1,11 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# NCAkit - Neural Content Automation Toolkit π€
|
| 2 |
|
| 3 |
-
A modular Python toolkit for content automation, featuring video creation,
|
| 4 |
|
| 5 |
## β¨ Features
|
| 6 |
|
| 7 |
- π¬ **Video Creator** - Short-form videos with TTS, captions, and music
|
| 8 |
-
-
|
|
|
|
| 9 |
- π **REST API** - FastAPI with auto-generated docs
|
| 10 |
- π **Ready for Deployment** - Docker & Hugging Face Spaces
|
| 11 |
|
|
@@ -24,9 +36,7 @@ NCAkit/
|
|
| 24 |
β
|
| 25 |
βββ modules/ # Feature modules
|
| 26 |
β βββ video_creator/ # Video creation module
|
| 27 |
-
β
|
| 28 |
-
β β βββ schemas.py # Pydantic models
|
| 29 |
-
β β βββ services/ # Core logic
|
| 30 |
β βββ _template/ # Template for new modules
|
| 31 |
β
|
| 32 |
βββ static/ # Web UI & assets
|
|
@@ -63,30 +73,30 @@ python app.py
|
|
| 63 |
|
| 64 |
## π‘ API Endpoints
|
| 65 |
|
| 66 |
-
|
| 67 |
-
|
|
| 68 |
-
|
|
| 69 |
-
|
|
| 70 |
-
|
|
| 71 |
-
|
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
``
|
| 90 |
|
| 91 |
## π³ Docker
|
| 92 |
|
|
@@ -95,16 +105,6 @@ docker build -t ncakit .
|
|
| 95 |
docker run -p 8880:8880 --env-file .env ncakit
|
| 96 |
```
|
| 97 |
|
| 98 |
-
## βοΈ Environment Variables
|
| 99 |
-
|
| 100 |
-
| Variable | Required | Default | Module |
|
| 101 |
-
|----------|----------|---------|--------|
|
| 102 |
-
| `PEXELS_API_KEY` | β
| - | Video Creator |
|
| 103 |
-
| `HF_TTS` | β
| - | Video Creator |
|
| 104 |
-
| `WHISPER_MODEL` | β | tiny.en | Video Creator |
|
| 105 |
-
| `PORT` | β | 8880 | Server |
|
| 106 |
-
| `LOG_LEVEL` | β | info | Server |
|
| 107 |
-
|
| 108 |
## π License
|
| 109 |
|
| 110 |
MIT
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: NCAkit
|
| 3 |
+
emoji: π¬
|
| 4 |
+
colorFrom: purple
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 8880
|
| 8 |
+
pinned: false
|
| 9 |
+
license: mit
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
# NCAkit - Neural Content Automation Toolkit π€
|
| 13 |
|
| 14 |
+
A modular Python toolkit for content automation, featuring video creation, AI story reels, and more.
|
| 15 |
|
| 16 |
## β¨ Features
|
| 17 |
|
| 18 |
- π¬ **Video Creator** - Short-form videos with TTS, captions, and music
|
| 19 |
+
- οΏ½ **Story Reels** - AI-powered character-consistent story videos (NEW!)
|
| 20 |
+
- οΏ½π **Modular Architecture** - Easy to add new features
|
| 21 |
- π **REST API** - FastAPI with auto-generated docs
|
| 22 |
- π **Ready for Deployment** - Docker & Hugging Face Spaces
|
| 23 |
|
|
|
|
| 36 |
β
|
| 37 |
βββ modules/ # Feature modules
|
| 38 |
β βββ video_creator/ # Video creation module
|
| 39 |
+
β βββ story_reels/ # AI Story Reels (NEW!)
|
|
|
|
|
|
|
| 40 |
β βββ _template/ # Template for new modules
|
| 41 |
β
|
| 42 |
βββ static/ # Web UI & assets
|
|
|
|
| 73 |
|
| 74 |
## π‘ API Endpoints
|
| 75 |
|
| 76 |
+
### Video Creator
|
| 77 |
+
| Endpoint | Method | Description |
|
| 78 |
+
|----------|--------|-------------|
|
| 79 |
+
| `/api/video/short-video` | POST | Create video |
|
| 80 |
+
| `/api/video/short-video/{id}/status` | GET | Check status |
|
| 81 |
+
| `/api/video/short-video/{id}` | GET | Download video |
|
| 82 |
+
|
| 83 |
+
### Story Reels (NEW!)
|
| 84 |
+
| Endpoint | Method | Description |
|
| 85 |
+
|----------|--------|-------------|
|
| 86 |
+
| `/api/story-reels/generate` | POST | Generate AI story video |
|
| 87 |
+
| `/api/story-reels/status/{id}` | GET | Check status |
|
| 88 |
+
| `/api/story-reels/download/{id}` | GET | Download video |
|
| 89 |
+
|
| 90 |
+
## βοΈ Environment Variables
|
| 91 |
+
|
| 92 |
+
| Variable | Required | Module |
|
| 93 |
+
|----------|----------|--------|
|
| 94 |
+
| `PEXELS_API_KEY` | β
| Video Creator |
|
| 95 |
+
| `HF_TTS` | β
| Video Creator / Story Reels |
|
| 96 |
+
| `NVIDIA_API_KEY` | β
| Story Reels (Primary) |
|
| 97 |
+
| `CF_URL` | β | Story Reels (Fallback) |
|
| 98 |
+
| `CF_API` | β | Story Reels (Fallback) |
|
| 99 |
+
| `GEMINI_API_KEY` | β
| Story Reels (AI Scripts) |
|
| 100 |
|
| 101 |
## π³ Docker
|
| 102 |
|
|
|
|
| 105 |
docker run -p 8880:8880 --env-file .env ncakit
|
| 106 |
```
|
| 107 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 108 |
## π License
|
| 109 |
|
| 110 |
MIT
|