nilswenning / WISC-O

WISC-O

A self-hosted Summarizing api
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Features
3. Getting Started
   • Prerequisites
   • Installation
   • Environment Variables
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

WISC-O stands for WhIsper Summarisation to Obsidian(idk yet) . WISC-O is a API that accepts audio or a YT-link and summarizes the content of the audio. After that it can be downloaded automatically downloaded with a Obsidian plugin. Because the transcription is the most expressive process you can choose between OpenAI or a Self-Hosted solution reduce cost by a huge factor.

Features:

• Accepts
  • Audio file
  • YouTube Link
• User can choose transcription service
  • Whisper-OpenAi
  • WAAS
  • WAAS-X
    • Self-hosted Whisper-X service
    • Not yet released
• Supports different users
  • So you can share it with your family and friends
  • Each user has a Quota so you the dont deplete your OpenAI credit
• iOS App (Basic function done but not released yet)
• Obsidian-Sync-Plugin

(back to top)

Getting Started

The easiest way to start is with a docker image. If you dont have it installed you get it here: Get Docker

Prerequisites

An OpenAI Key is mandatory to use this API
Get It Here: https://platform.openai.com/api-keys

Installation

1. Clone the repo

   git clone https://github.com/nilswenning/WISC-O

2. change your settings in the docker-compose.yml
3. Run the docker Container

   sudo docker compose up -d --build

4. {"detail":"Not Found"} should pop up if you visit http://your-ip:8000

(back to top)

Environment Variables

Environment Variable	Required/Optional	Description
OPENAI_API_KEY	Required	OpenAI Key
admin_email	Required	Admin user's email address
admin_password	Required	Admin user's password
admin_api_key	Required	Admin user's API key
redis_host	Optional	Redis server Required if address is not localhost
JOJO_BASE_URL	Optional	Base URL for JOJO service
JOJO_AUTH_USER	Optional	Username for JOJO service authentication
JOJO_AUTH_PASSWORD	Optional	Password for JOJO service authentication
JOJO_WEBHOOK_ID	Optional	Webhook ID for JOJO service
WAASX_BASE_URL	Optional	Base URL for WAASX service
WAASX_AUTH_USER	Optional	Username for WAASX service authentication
WAASX_AUTH_PASSWORD	Optional	Password for WAASX service authentication
gpt_model	Optional	Default GPT model to be used Default: gpt-3.5-turbo-0125

Roadmap

• Basic OpenAI-Flow
• Added Self-Hosted Transcription Services
• Added Users
  • User Manegment
• Add ollama Support (self-hosted Chat-GPT alternative)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nils Wenning - [e-mail]

Project Link: https://github.com/nilswenning/WISC-O

(back to top)

Acknowledgments

• WAAS by Schibsted
  • They bought me on the idea
• m-bain with WhisperX

(back to top)