Derived from "Audio Exchange", Smart Medical Recording & Transcription System with voice recognition and speaker identification.
Documentation • Installation Guide • API Reference
English | 简体中文
- Python 3.10-3.13
- Poetry
- PortAudio
- FFmpeg
- SQLite3
- PyQt6 (Linux: install from system packages)
- NetworkManager (Linux: for WiFi connectivity)
Ubuntu/Debian:
sudo apt-get install python3-pyqt6 python3-pyqt6.qtwebengine \
portaudio19-dev ffmpeg sqlite3 network-manager \
libfcitx5-qt6-1 alsa-utils gcc build-essentialmacOS:
brew install portaudio ffmpeg sqlite3
pip install PyQt6 PyQt6-WebEngineWindows:
- PortAudio is bundled with PyAudio wheel
- FFmpeg: Download from https://ffmpeg.org/download.html and add to
PATH - SQLite3: Included with Python installation
pip install audexgit clone https://github.com/6ixGODD/audex.git
cd audex
poetry installDownload the appropriate DEB package for your architecture from Releases.
For detailed installation instructions, see Installation Guide.
Quick Install:
# Download and install
sudo dpkg -i audex_{version}_arm64.deb
sudo apt-get install -f
# Run configuration wizard
sudo audex-setup
# Start application
sudo audex# Start with config file
audex -c config.yaml
# Using installed package
python -m audex -c config.yaml# Generate default configuration
audex init gencfg --format yaml --output config.yaml
# Generate system configuration (Linux)
audex init gencfg --format system --output /etc/audex/config.yml --platform linux# Initialize voice print recognition group
audex init vprgroup --config config.yaml# Start file export server
audex serve --config config.yamlConfiguration file structure:
core:
app:
app_name: Audex
native: true
logging:
targets:
- logname: stdout
loglevel: info
audio:
sample_rate: 16000
provider:
transcription:
provider: dashscope
dashscope:
credential:
api_key: <YOUR_API_KEY>
vpr:
provider: xfyun
xfyun:
credential:
app_id: <YOUR_APP_ID>
api_key: <YOUR_API_KEY>
api_secret: <YOUR_API_SECRET>
infrastructure:
sqlite:
uri: "sqlite+aiosqlite:///path/to/audex.db"
store:
type: localfile
base_url: /path/to/storeSee config.example.yml for complete configuration options.
# Development environment
poetry install --extras dev
# Testing environment
poetry install --extras test
# Documentation environment
poetry install --extras docs# Build wheel and sdist
poetry build
# Output: dist/audex-{version}-py3-none-any.whlpoetry install --extras test
poetry run pytestpoetry install --extras docs
poetry run mkdocs serve
# Visit: http://127.0.0.1:8000Prerequisites:
- Docker
Build:
cd packaging/linux
# Build for ARM64 (Raspberry Pi)
./build.sh
# Build for AMD64
./build.sh amd64Output: dist/audex_{version}_{arch}.deb
cd packaging/linux
./test.sh arm64Inside test container:
# Install package
dpkg -i /tmp/audex.deb
apt-get install -f
# Verify installation
which audex
audex --version
# View configurations
cat /etc/audex/config.system.yml
cat /etc/audex/config.example.yml
# Run configuration wizard
audex-setup
# Exit container
exitaudex/
├── audex/ # Main package
│ ├── cli/ # Command-line interface
│ ├── service/ # Business layer
│ ├── entity/ # Entities
│ ├── filters/ # Data filters
│ ├── valueobj/ # Value objects
│ ├── view/ # View layer
│ └── lib/ # Shared libraries
├── packaging/
│ └── linux/ # DEB packaging
│ ├── templates/ # Package templates
│ ├── build.sh # Build script
│ └── test.sh # Test script
├── scripts/ # Development scripts
├── tests/ # Test suite
└── pyproject.toml # Project configuration
- Documentation: https://6ixgodd.github.io/audex/
- PyPI: https://pypi.org/project/audex/
- GitHub: https://github.com/6ixGODD/audex
- Issues: https://github.com/6ixGODD/audex/issues
- Releases: https://github.com/6ixGODD/audex/releases