sugarforever / whispering

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Whispering

Whispering is the API service for transcription.

Get Started

  1. Clone this repository

    git clone git@github.com:sugarforever/whispering.git
  2. Install poetry

    Whispering is using poetry to manage python dependencies.

    curl -sSL https://install.python-poetry.org | python3 -
  3. Go to the cloned directory whispering, initialize a poetry shell, and install the dependencies.

    $ cd whispering
    
    $ poetry shell
    
    $ poetry install
  4. Copy .env.example to .env and set OPENAI_API_KEY

    There are 2 environmental variables referenced by the service:

    • X_API_KEYS

      X_API_KEYS is used to protect the API endpoint from anonymous usage. You should always pass it as a HTTP header X-API-KEY.

    • OPENAI_API_KEY

      OPENAI_API_KEY is used to call the OpenAI transcribe API.

  5. Start the service

    poetry run uvicorn main:app

    The service should be up and running on http://localhost:8000

About


Languages

Language:Python 88.1%Language:Dockerfile 11.9%