ismdrobiul489 commited on
Commit
fa5c7f4
Β·
1 Parent(s): 7fa9d90

Add HF Spaces metadata and update README

Browse files
Files changed (1) hide show
  1. README.md +39 -39
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, text-to-speech, and more.
4
 
5
  ## ✨ Features
6
 
7
  - 🎬 **Video Creator** - Short-form videos with TTS, captions, and music
8
- - πŸ”Œ **Modular Architecture** - Easy to add new features
 
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
- β”‚ β”‚ β”œβ”€β”€ router.py # API endpoints
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
- | Module | Endpoint | Method | Description |
67
- |--------|----------|--------|-------------|
68
- | System | `/health` | GET | Health check |
69
- | System | `/api/modules` | GET | List modules |
70
- | Video | `/api/video/short-video` | POST | Create video |
71
- | Video | `/api/video/short-video/{id}/status` | GET | Check status |
72
- | Video | `/api/video/short-video/{id}` | GET | Download video |
73
-
74
- ## πŸ”§ Adding New Modules
75
-
76
- 1. Copy `modules/_template/` to `modules/your_module/`
77
- 2. Update `MODULE_NAME`, `MODULE_PREFIX` in `__init__.py`
78
- 3. Implement router and services
79
- 4. Restart server - auto-discovered!
80
-
81
- ```python
82
- # modules/your_module/__init__.py
83
- MODULE_NAME = "your_module"
84
- MODULE_PREFIX = "/api/your-feature"
85
-
86
- def register(app, config):
87
- from .router import router
88
- app.include_router(router, prefix=MODULE_PREFIX)
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