Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phidlarkson/ghana-nlp-python-library
A Python library for interacting with the GhanaNLP APIs
https://github.com/phidlarkson/ghana-nlp-python-library
africa ghana-nlp library localisation python
Last synced: 2 months ago
JSON representation
A Python library for interacting with the GhanaNLP APIs
- Host: GitHub
- URL: https://github.com/phidlarkson/ghana-nlp-python-library
- Owner: PhidLarkson
- License: mit
- Created: 2024-09-28T22:32:01.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-04T00:58:59.000Z (2 months ago)
- Last Synced: 2024-11-04T01:27:41.698Z (2 months ago)
- Topics: africa, ghana-nlp, library, localisation, python
- Language: Python
- Homepage: https://translation.ghananlp.org/
- Size: 3.91 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ghana NLP Python Library
The **[Ghana NLP API](https://translation.ghananlp.org/) Python Library** provides an easy way to integrate local African language technologies into your Python projects. Whether you're looking for **translation**, **speech-to-text (STT)**, or **text-to-speech (TTS)**, this library makes it simple and intuitive to get started.
## Features
- **Translation**: Translate text between supported African languages (e.g., English to Twi).
- **Speech-to-Text (STT)**: Convert audio files into text.
- **Text-to-Speech (TTS)**: Generate natural-sounding speech from text in local languages.
## Installation
You can install the library directly from PyPI:
```bash
pip install ghana-nlp
```
And update to the lastest version
```bash
python -m pip install --upgrade ghana-nlp
```
## Usage
### Initialize the Library
First, import the library and set your API key:
```python
from ghana_nlp import GhanaNLP
nlp = GhanaNLP(api_key="your_api_key_here")
```
### Translation
Translate from English to Twi:
```python
result = nlp.translate("Hello, how are you?", language_pair="en-tw")
print(result) # Wo ho te sɛn?
```
### Speech-to-Text (STT)
Convert an audio file (WAV format) to text:
```python
result = nlp.stt("your_audio_file.wav", language="tw")
print(result)
```
### Text-to-Speech (TTS)
Convert text to speech:
```python
result = nlp.tts("Good morning", lang="tw")
print(result) # audio binary, write a code to either serve to an audio file or play directly
```
Check this repo to guide you with dealing with audio binary data: [EXAMPLE CODE](https://github.com/PhidLarkson/ghananlp-tts-python)
## Supported Languages
The library supports multiple African languages, including:
- **English (en)**
- **Twi (tw)**
- **Ga (gaa)**
- **Ewe (ee)**
- **Fante (fat)**
- **Dagbani (dag)**, and more!
## Error Handling
The library provides clear error messages if something goes wrong, such as incorrect language codes or invalid API requests. Check the `message` field in the response for details.
## License
This library is licensed under the MIT License.
---
For more details, check out the [documentation](https://pkwolffe.hashnode.dev/ghana-nlp-python-library) and start building cool stuff with **Ghana NLP**! 🎉