Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hitesh22rana/soundscripter
Simplify and Automate your transcription workflow with SoundScripter
https://github.com/hitesh22rana/soundscripter
ai celery docker fastapi live-notifications open-source postgresql python rabbitmq redis redis-pubsub server-sent-events whisper whisper-cpp
Last synced: 1 day ago
JSON representation
Simplify and Automate your transcription workflow with SoundScripter
- Host: GitHub
- URL: https://github.com/hitesh22rana/soundscripter
- Owner: hitesh22rana
- License: mit
- Created: 2023-08-28T00:04:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-06T22:03:15.000Z (9 months ago)
- Last Synced: 2024-04-07T12:27:15.596Z (9 months ago)
- Topics: ai, celery, docker, fastapi, live-notifications, open-source, postgresql, python, rabbitmq, redis, redis-pubsub, server-sent-events, whisper, whisper-cpp
- Language: TypeScript
- Homepage:
- Size: 2.23 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SoundScripter 🔊📝
Simplify and Automate your transcription workflow with SoundScripter
## Features
- **Media Transcription:** Convert media files (audio/video) to text with high accuracy.
- **Scalable:** Utilizes a distributed architecture to handle multiple requests in parallel.
- **Real-time Notifications:** Uses Redis Pub-Sub and Server-Sent Events (SSE) for real-time notifications
## Architecture
SoundScripter's architecture is designed to handle transcription requests efficiently. Here's how it works:
1. **User Requests:** Users uploads video/audio files for transcription through API.
2. **Optimization:** Media files are optimized to be utilized for transcription service.
3. **RabbitMQ Message Broker:** Transcription requests are added to the RabbitMQ message broker.
4. **Celery Task Queue:** Celery task queues manages and distribute the tasks. When new tasks are added to the queue, Celery workers pick them up and process them asynchronously and concurrently.
5. **Task Execution:** Each task runs in its own container, allowing for parallel processing of multiple tasks based on the system configuration.
6. **Realtime Notifications:** SoundScripter leverages Redis Pub-Sub and Server-Sent Events (SSE) for real-time notifications.
## Getting Started
To run SoundScripter locally or in a server environment, follow these steps:
1. Clone this repository to your local machine
```bash
git clone https://github.com/hitesh22rana/SoundScripter.git
```
2. Navigate to the SoundScripter directory
```bash
cd SoundScripter
```
3. Make sure to change the file permission, if not done already
```bash
chmod +x scripts/build.sh scripts/check-requirements.sh
```
4. Check the requirements
```bash
sh scripts/check-requirements.sh
```
or
```bash
make check-requirements
```
5. Build and run the application
```bash
sh scripts/build.sh
```
or
```bash
make run
```
6. After the successful build your app will be up and running and you can access it via `http://localhost:3000`.
7. Clean and remove the running application
```bash
docker-compose -f docker-compose.yml down --remove-orphans
```
or
```bash
make clean
```
## Contributions
We welcome contributions to improve SoundScripter. Feel free to open issues, submit pull requests, or reach out with your ideas.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.