Skip to content

DeveloperGuide.md

Latest commit

 

History

History
85 lines (60 loc) · 2.49 KB

DeveloperGuide.md

File metadata and controls

85 lines (60 loc) · 2.49 KB
Raw

Developer Guide

🎬 Testing Code changes

Unit Tests

Run all unit tests

cd transcribe
python -m unittest discover --verbose .\tests
cd transcribe\app\transcribe
run_tests.bat

Live transcription provider smoke tests are opt-in because they require local models, provider binaries, optional dependencies, or API keys:

cd transcribe
set TRANSCRIBE_REAL_STT_SMOKE=1
venv\Scripts\python.exe -m unittest app.transcribe.tests.test_provider_smoke_optional -v

The deterministic live transcription tests use provider fixtures and mocks and run as part of the normal app.transcribe.tests suite.

Security Scanning

We use bandit for security scanning

bandit -c ./build/bandit.yaml -r .

To find only high level vulnerabilities run this command
bandit -ll -c ./build/bandit.yaml -r .

Creating Windows installs

Install Winrar from https://www.win-rar.com/.

Winrar is required for generating binaries from python code. If you do not intend to generate binaries and are only writing python code, you do not need to install winrar.

Install pyInstaller

pip install pyinstaller==6.7.0

In the file generate_binary.bat replace these paths at the top of the file to paths specific to your machine.

SET SOURCE_DIR=D:\Code\transcribe  
SET OUTPUT_DIR=D:\Code\transcribe\output
SET LIBSITE_PACAGES_DIR=D:\Code\transcribe\venv\Lib\site-packages
SET EXECUTABLE_NAME=transcribe.exe
SET ZIP_FILE_DIR=D:\Code\transcribe\transcribe.rar
SET WINRAR=C:\Program Files\WinRAR\winRAR.exe

Run generate_binary.bat file by replacing paths at the top of the file to the ones in your local machine. It should generate a zip file with everything compiled. To run the program simply go to zip file > transcribe.exe.

Software Installation

Note that installation files are generated every few weeks. So these file will almost always trail the latest codebase available in the repo. Latest Binary

  • Generated: 2024-06-02
  • Git version: 3b3502d
  1. Download the zip file from
https://drive.google.com/file/d/1kcgGbTKxZqgbJOShL0bc3Do34lLouYxF/view?usp=drive_link

  1. Unzip the files in a folder.

  2. (Optional) Replace the Open API key in parameters.yaml or override.yaml file in the transcribe directory:

    Replace the Open API key in parameters.yaml file manually. Open in a text editor and alter the line:

      api_key: 'API_KEY'

    Replace "API_KEY" with the actual OpenAI API key. Save the file.

  3. Execute the file transcribe\transcribe.exe\transcribe.exe