Metadata-Version: 2.4
Name: oremi-izwi
Version: 4.0.0b1
Summary: High-performance Text-to-Speech (TTS) REST API service for the Oremi ecosystem
Project-URL: Say Thanks!, https://www.buymeacoffee.com/demsking
Project-URL: Documentation, https://demsking.gitlab.io/oremi-izwi
Project-URL: Source, https://gitlab.com/demsking/oremi-izwi
Project-URL: Issues, https://gitlab.com/demsking/oremi-izwi/-/issues
Author-email: Sébastien Demanou <demsking@gmail.com>
Maintainer-email: Sébastien Demanou <demsking@gmail.com>
License: Apache-2.0
License-File: LICENSE
License-File: LICENSE_HEADER.txt
Keywords: Text-to-Speech,tts
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Requires-Dist: fastapi[standard]>=0.136.3
Requires-Dist: pydantic-settings>=2.14.1
Requires-Dist: soundfile>=0.14.0
Requires-Dist: supertonic>=1.3.1
Description-Content-Type: text/markdown

# Oremi Izwi

[![Buy me a beer](https://img.shields.io/badge/Buy%20me-a%20beer-1f425f.svg)](https://www.buymeacoffee.com/demsking)

_Oremi Izwi_ stands as the auditory cornerstone of the Oremi project, a
revolutionary initiative aimed at redefining the personal assistant landscape.

Leveraging cutting-edge TTS (Text-to-Speech) technology powered by
[Supertonic](https://github.com/Supertone-Inc/supertonic), this module
effortlessly transforms textual inputs into rich, lifelike speech, elevating
user interactions to a whole new level of realism and immersion. Notably, Oremi
Izwi supports streaming TTS endpoints, ensuring seamless and uninterrupted
delivery of audio content for an even smoother user experience.

The name **Oremi Izwi** combines rich African linguistic traditions to embody its
core mission. _Oremi_ is derived from the Yoruba phrase (*Ọrẹ́ mi*) meaning
**"my friend"**, while _Izwi_ comes from the Zulu word for **"voice"**. Together,
**Oremi Izwi** translates to *"My Friend's Voice"*, representing a personal
assistant framework designed to communicate with warmth, clarity, and familiarity,
transforming mere commands into engaging conversations.

![Oremi Izwi Logo](htdocs/logo.jpg)

## Documentation

Open the documentation URL to access the API documentation. In your web browser,
navigate to https://demsking.gitlab.io/oremi-izwi.

## Development

Oremi Izwi is built with Python and uses `uv` for dependency management. The
project follows standard Python development practices with type hints, linting,
and automated testing.

For detailed information on setting up your development environment, running
tests, code style guidelines, and the pull request process, please refer to
[CONTRIBUTING.md](https://gitlab.com/demsking/oremi-izwi/-/blob/main/CONTRIBUTING.md).

## Versioning

Given a version number `MAJOR.MINOR.PATCH`, increment the:

- `MAJOR` version when you make incompatible API changes,
- `MINOR` version when you add functionality in a backwards-compatible manner,
  and
- `PATCH` version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions
to the `MAJOR.MINOR.PATCH` format.

See [SemVer.org](https://semver.org/) for more details.

## License

Copyright 2024-2026 Sébastien Demanou. All Rights Reserved.

Licensed under the Apache License, Version 2.0. See the
[LICENSE](https://gitlab.com/demsking/oremi-izwi/-/blob/main/LICENSE) for the
complete license text.
