-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,10 @@ | ||
| # Welcome to project-W-runner | ||
| # Runner for Project W | ||
|
|
||
| [](https://opensource.org/license/agpl-v3) | ||
| [](https://github.com/JulianFP/project-W-runner/actions/workflows/ci.yml) | ||
| [](https://project-W-runner.readthedocs.io/) | ||
| [](https://codecov.io/gh/JulianFP/project-W-runner) | ||
|
|
||
| ## Installation | ||
|
|
||
| The Python package `project_W_runner` can be installed from PyPI: | ||
|
|
||
| ``` | ||
| python -m pip install project_W_runner | ||
| ``` | ||
|
|
||
| ## Development installation | ||
|
|
||
| If you want to contribute to the development of `project_W_runner`, we recommend | ||
| the following editable installation from this repository: | ||
|
|
||
| ``` | ||
| git clone git@github.com:JulianFP/project-W-runner.git | ||
| cd project-W-runner | ||
| python -m pip install --editable .[tests] | ||
| ``` | ||
|
|
||
| Having done so, the test suite can be run using `pytest`: | ||
|
|
||
| ``` | ||
| python -m pytest | ||
| ``` | ||
| ## What is this? | ||
| This is the runner for Project-W written in Python. Its job is to process the transcription jobs that the backend assigns to it, which means that the runner is the place where the actual whisper speech-to-text code runs. It has been designed as an http client such that it doesn't have any firewall requirements or similar. All communcations between backend and runner are initiated from the runner only! To learn more about Project W (including its runner) and how to install and run it, [visit its documentation](https://project-w.readthedocs.io). Other components of Project W are [the backend](https://github.com/JulianFP/project-W) and [the frontend](https://github.com/JulianFP/project-W-frontend). | ||
|
|
||
| ## Acknowledgments | ||
|
|
||
| This repository was set up using the [SSC Cookiecutter for Python Packages](https://github.com/ssciwr/cookiecutter-python-package). |