Voicebot

A simple Danish voice bot.

---

Developers:

• Dan Saattrup Nielsen (dan.nielsen@alexandra.dk)

Setup

Set up the environment

1. Run make install, which installs Poetry (if it isn't already installed), sets up a virtual environment and all Python dependencies therein.
2. Run source .venv/bin/activate to activate the virtual environment.

Install new packages

To install new PyPI packages, run:

$ poetry add <package-name>

Get an overview of the available commands

Simply write make to display a list of the commands available. This includes the above-mentioned make install command, as well as building and viewing documentation, publishing the code as a package and more.

Tools used in this project

• Poetry: Dependency management
• hydra: Manage configuration files
• pre-commit plugins: Automate code reviewing formatting
• pdoc: Automatically create an API documentation for your project

Project structure

.
├── .github
│   └── workflows
│       ├── ci.yaml
│       └── docs.yaml
├── .gitignore
├── .pre-commit-config.yaml
├── .ruff_cache
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── config
│   ├── __init__.py
│   ├── config.yaml
│   └── hydra
│       └── job_logging
│           └── custom.yaml
├── docs
│   └── .gitkeep
├── makefile
├── poetry.lock
├── poetry.toml
├── pyproject.toml
├── src
│   ├── scripts
│   │   ├── __pycache__
│   │   ├── fix_dot_env_file.py
│   │   └── run_bot.py
│   └── voicebot
│       ├── __init__.py
│       ├── __pycache__
│       ├── bot.py
│       ├── speech_recognition.py
│       ├── speech_recording.py
│       ├── speech_synthesis.py
│       └── text_engine.py
└── tests
    ├── __init__.py
    ├── __pycache__
    └── test_dummy.py

1"""
2.. include:: ../../README.md
3"""
4
5import importlib.metadata
6from .bot import VoiceBot
7
8# Fetches the version of the package as defined in pyproject.toml
9__version__ = importlib.metadata.version(__package__)