alex/annescribe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh README

Browse Source
This commit is contained in:
Alex
2026-07-27 15:24:01 +02:00
parent 7d2498e9c9
commit 8a2ea05dc1
1 changed files with 69 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+69 -63
View File
@@ -1,93 +1,99 @@
# annescribe # AnneScribe
AnneScribe is a Streamlit web application for creating and monitoring filesystem-backed audio-transcription jobs. Users upload WAV, MP3, FLAC, or OGG audio; the application splits the audio and transcribes chunks with Whisper, then writes a combined `output.txt` for each job.
## Status and important limitations
## Getting started This is an early, filesystem-backed application rather than a production-ready transcription service.
To make it easy for you to get started with GitLab, here's a list of recommended next steps. - The application has no tracked authentication example. Although a missing `AUTH_FILE` disables the authentication setup, the current home page still calls the authenticator's logout method unconditionally; the unauthenticated path is therefore not a supported runnable mode. Treat an absent auth file as unsafe for exposed deployments.
- `auth.yml` is ignored by Git. Create it locally from the configuration shape required by `streamlit-authenticator`; do not commit credentials, cookie keys, or other private settings.
- The checked-in `config.yml` selects `cuda`. A working CUDA/PyTorch setup is needed for that configuration; a CPU configuration must set the model device accordingly.
- Jobs and uploads are stored on the filesystem. The included Compose configuration does not declare a persistent volume for those directories, so container recreation can lose job data.
- The task list does not automatically refresh; use the UI refresh control.
- No project test suite or test command is defined. GitLab CI includes only the SAST template.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! ## Prerequisites
## Add your files - Python **3.10.16** for local installation (the project requires exactly this version).
- FFmpeg for local audio conversion and splitting. The supplied Dockerfile installs it.
- A Python environment capable of installing the dependencies declared in `pyproject.toml`, including PyTorch, OpenAI Whisper, Streamlit, and pydub.
- A writable location for uploads and job data.
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files ## Local setup and run
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
``` From the repository root, install the package:
cd existing_repo
git remote add origin https://gitlab.com/blankinator/annescribe.git ```bash
git branch -M main python -m pip install .
git push -uf origin main
``` ```
## Integrate with your tools Copy or create a local application configuration. The tracked `config.yml` is a starting point for non-secret settings. Set the paths and model device for the environment, and create a private `auth.yml` if authentication is required.
- [ ] [Set up project integrations](https://gitlab.com/blankinator/annescribe/-/settings/integrations) Run the Streamlit entry point from the repository root:
## Collaborate with your team ```bash
streamlit run src/annescribe/webapp_main.py
```
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) The repository does not define a separate development server, test, lint, or format command.
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy ## Configuration
Use the built-in continuous integration in GitLab. The application reads these environment variables:
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) | Variable | Default | Purpose |
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) | --- | --- | --- |
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) | `CONFIG_FILE` | `config.yml` | YAML application configuration path |
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) | `AUTH_FILE` | `auth.yml` | YAML authentication configuration path; if missing, authentication is disabled |
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
*** `CONFIG_FILE` must exist. Its YAML is read for:
# Editing this README ```yaml
jobs:
root_directory: ./jobs
data:
upload_directory: ./uploads
audio:
chunking:
min_silence_level: -30
min_silence_length: 400
ms_silence_to_keep: 50
model:
type: large
device: cuda
```
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. Use paths appropriate for the process working directory. `model.type` is passed to Whisper, and `model.device` is used to move the loaded model.
## Suggestions for a good README When present, the authentication YAML must provide the `credentials` and `cookie` objects read by `streamlit-authenticator`; the code reads `cookie.name`, `cookie.key`, and `cookie.expiry_days`. Keep this file private.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. ## Using the UI
## Name 1. Start the application and log in when authentication is configured.
Choose a self-explaining name for your project. 2. Choose **Create Task** and upload WAV, MP3, FLAC, or OGG audio.
3. The application writes the upload to `data.upload_directory`, creates a job beneath `jobs.root_directory`, and starts a background transcription process.
4. Use the task list to view progress and completed output. A job name is derived from the uploaded filename; choose the overwrite option to rerun a job with the same name.
## Description > **Security warning:** uploaded filenames reach shell-based processing. Run this UI only for trusted, authenticated users and filenames, and do not place it behind an unauthenticated upload proxy.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges ## Container operation
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals The repository supplies a Dockerfile and Compose file. From the repository root, build and start it with:
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation ```bash
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. docker compose up --build
```
## Usage The Compose service exposes port `8501`, mounts local `config.yml` and `auth.yml` into `/app`, and expects an existing external Docker network named `web`. It also contains Traefik labels, so its proxy configuration assumes a compatible Traefik environment. Create and secure the external network and the private `auth.yml` before using this configuration.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support The image starts the same Streamlit entry point. No deployment automation or production persistence configuration is defined beyond this Compose file.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap ## Repository layout
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing - `src/annescribe/webapp_main.py` — Streamlit entry point and configuration/authentication loading
State if you are open to contributions and what your requirements are for accepting them. - `src/annescribe/webapp/` — home page, task list, and upload UI
- `src/annescribe/transcription/` — audio conversion, splitting, job handling, and Whisper transcription
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - `config.yml` — tracked non-secret application configuration
- `Dockerfile`, `docker-compose.yml` — container build and local Compose configuration
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - `pyproject.toml` — Python package metadata and runtime dependencies
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.