OroAutoGrammar-Ebisa 0.0.1
A python package that recieves an Oromo text file from a user, and generates a grammar-based dataset of Oromo phrases
Requires Python: >=3.8


# OroAutoGrammar Package

# Project Title

A Python package that automatically generates grammar aware Oromo phrases from a given raw text.

## Description

This is a novel python package that recieves an Oromo text file from a user; extract every possible root-verbs from the text;
and stores them into a python list. It then trims all the verbs in the list to form their corresponding list of stems.
Finally, the algorithm builds the corresponding phrases from the stems using an appropriate affixation and personal pronouns. 
The package can be customized and be repicated for any other languages according to the gramatical structure of the language.
It helps relief machine learning and NLP practitioners,by automatically generating a clean and grammar aware dataset,which was 
used to be done only manually. The generated Oromo phrases can indicate sentence elements like, number, gender and cases. The 
automatically generated Oromo phrases can be applied to different machine learning applications. It can form a clean phrase-based
dataset that can help to train a Neural Machine Translation (NMT). It can also form a word and phrase-based dictionery, that will
help in automatic word/sentence completion. The output of this tool is also helpful for Linguistics, in providing a clean and
correct gramatical information of the language.
  
## Getting Started

### Dependencies

* This software package can run on any platform/OS(Windows, Linux, or Mac) and no prerequisites is given, except the Python Software Specifications.
* This software requires Python 3.8 or latter versions, with all its full liberary packages for a smooth excusion.

### Installing

* Before installing "OroAutoGrammar" package first check that you have Python 3 software installed on your device. If not already installed
* Python software on your machine, first download and install the latest python version from https://www.python.org/, to use it on your machine.
  
* To install and use this package, first download the "OroAutoGrammar" package from PyPI package open distribution "https://pypi.org/".
* The easiest way to install the package is via pip (pip3 in some distributions): "pip install OroAutoGrammar" -for Window, or
* "pip3 install OroAutoGrammar" -for Unix/macOS.

### Executing program

* To use the OroAutoGrammar program package:
* First prepare/get an Oromo text file as like "oro_text.txt" document.
* Save the file in your working directory, e.g., "C:\oro_text.txt" 
* Copy and paste the fully directory path of your file ("C:\oro_text.txt" ) into the user text box, and click enter.
* Then go a head and chock the generated csv file that is created in the same working directory. There you find
* an axcel file that contains the generated Oromo grammar dataset.

## Authors

Contributors names and contact info

Ebisa A. Gemechu  
@Ebisa |lammiyad@yahoo.com| (https://www.linkedin.com/ebisa-asfaw-39566361)

## Version History

* 0.1
    * Initial Release

## License

This project is licensed under the MIT License - see the LICENSE.md file for details