cse2000-software-project/kernel
2024-06-21 21:46:35 +00:00
..
spectral Merge branch 'dev' into 'user-improvements' 2024-06-20 16:09:40 +02:00
tests Merge branch 'dev' into 'user-improvements' 2024-06-20 16:09:40 +02:00
.dockerignore feat: add docker-compose for production & stuff 2024-06-06 23:59:43 +02:00
.gitignore feat: setup mutation testing for python 2024-05-21 22:11:27 +02:00
CONTRIBUTING.md chore: improve docs 2024-05-21 22:23:52 +02:00
Dockerfile chore: rename backend to kernel and frontend to app 2024-05-21 10:18:47 +02:00
Dockerfile.prod fix: prefer compatibility over performance :( 2024-06-17 11:22:51 +00:00
mutmut_config.py feat: setup new and better ruff 2024-06-12 09:45:10 +00:00
poetry.lock Merge pull request #1 from TU-Delft-SALT-Group/dependabot/pip/kernel/urllib3-2.2.2 2024-06-21 12:37:22 +02:00
pyproject.toml docs: set the correct links to repo and docs 2024-06-21 14:12:38 +02:00
README.md docs: Polished READMEs and CONTRIBUTINGs 2024-05-29 00:17:18 +02:00

Spectral kernel

Run kernel locally

For the kernel we are using uvicorn. To start up the server locally run:

uvicorn dev spectral/main.py

This will allow you to look at the autogenerated OpenAPI documentation at http://127.0.0.1:8000/docs and make calls to the api via http://127.0.0.1:8000/

api keys

To be able to use the deepgram model for the endpoint api/transcription/{model}/{id} you must store an apikey from https://deepgram.com/ in a DG_KEY environment key as follows:

DG_KEY = <your_api_key>