Skip to content

FAQ.md

Latest commit

 

History

History
32 lines (25 loc) · 1.13 KB

FAQ.md

File metadata and controls

32 lines (25 loc) · 1.13 KB

FAQ — ovos-utils

What is ovos-utils?

ovos-utils is collection of simple utilities for use across the openvoiceos ecosystem.

How do I install it?

pip install ovos-utils

Or for development:

uv pip install -e ovos-utils/

Where do I report bugs?

Open an issue on the GitHub repository. Ensure you are targeting the dev branch for fixes.

How do I run tests?

uv run pytest ovos-utils/test/ --cov=ovos_utils

How do I contribute?

  1. Fork the repository and create a feature branch from dev.
  2. Write tests for your changes.
  3. Open a PR targeting the dev branch.
  4. Ensure CI passes before requesting review.

Why do I get AttributeError: module 'ovos_utils.version' has no attribute '__version__' during build?

This usually happens in isolated build environments (like python -m build) when a dependency (like kthread) is missing and the package __init__.py attempts to import it before the version can be read. We have mitigated this by making kthread a lazy import in ovos_utils/thread_utils.py. If you encounter this with other dependencies, ensure they are also loaded lazily.