The python module for converting lexc to dix files format
Project description
# lexc2dix
A software that parses over the existing lttoolbox format and generates the corresponding monolingual dictionary in lttoolbox format. The package is modular and is user-friendly with proper help message and usage instructions. This was done as a part of coding challenge for the project `Extend lttoolbox to have the power of HFST`.
INSTALLATION
------------
If you are a user and are simply looking to install the package, just type the command given below in your terminal window.
```
$ pip3 install lexc2dix
```
To get proper usage instructions for the package, type the command given below.
```
$ lexc2dix -e
```
GETTING STARTED
---------------
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### CLONE THE REPOSITORY
```
$ git clone https://github.com/Techievena/lexc2dix.git
$ cd lexc2dix
```
### INSTALL PREREQUISITES
```
$ pip3 install -r requirements.txt
$ pip3 install -r test-requirements.txt
```
### INSTALL THE PACKAGE
```
$ python3 setup.py install
```
### USAGE
```
$ lexc2dix --help
usage: lexc2dix [-h] [-e] [-v] [filename]
lexc2dix
positional arguments:
filename
optional arguments:
-h, --help show this help message and exit
-e
-v, --version
$ lexc2dix tests/test_files/apertium-kaz.kaz.lexc
```
EXTERNAL LIBRARIES USED
-----------------------
* regex 2018.02.21 (Python 3)
CAPABILITIES AND POSSIBILITIES
------------------------------
The lexc2dix module is expected to function as follows:
- [x] Parses over the lexc files.
- [x] Stores them in form of python dictionaries.
- [x] Generates the monolingual dictionary files.
CONTRIBUTION
------------
The work flow is the same as that of any other repository.
1.Fork / clone the repository.
2.Create a new branch , say `my-changes` and make your changes in this branch.
3.Commit your changes and send a Pull request (PR) to this repository.
Active contributors would be rewarded with the tag of "Collabrators".
Bug fixes , Issues , Issue solutions , Optimizations & Enhancements are always welcome.
LICENSE
-------
The GNU GENERAL PUBLIC LICENSE - [Abinash Senapati](http://github.com/Techievena) - All Rights Reserved.
ACKNOWLEDGEMENTS
----------------
I would like to thank mentors at [Apertium](https://github.com/Apertium) for helping me with the development and maintenance of this package.
A software that parses over the existing lttoolbox format and generates the corresponding monolingual dictionary in lttoolbox format. The package is modular and is user-friendly with proper help message and usage instructions. This was done as a part of coding challenge for the project `Extend lttoolbox to have the power of HFST`.
INSTALLATION
------------
If you are a user and are simply looking to install the package, just type the command given below in your terminal window.
```
$ pip3 install lexc2dix
```
To get proper usage instructions for the package, type the command given below.
```
$ lexc2dix -e
```
GETTING STARTED
---------------
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### CLONE THE REPOSITORY
```
$ git clone https://github.com/Techievena/lexc2dix.git
$ cd lexc2dix
```
### INSTALL PREREQUISITES
```
$ pip3 install -r requirements.txt
$ pip3 install -r test-requirements.txt
```
### INSTALL THE PACKAGE
```
$ python3 setup.py install
```
### USAGE
```
$ lexc2dix --help
usage: lexc2dix [-h] [-e] [-v] [filename]
lexc2dix
positional arguments:
filename
optional arguments:
-h, --help show this help message and exit
-e
-v, --version
$ lexc2dix tests/test_files/apertium-kaz.kaz.lexc
```
EXTERNAL LIBRARIES USED
-----------------------
* regex 2018.02.21 (Python 3)
CAPABILITIES AND POSSIBILITIES
------------------------------
The lexc2dix module is expected to function as follows:
- [x] Parses over the lexc files.
- [x] Stores them in form of python dictionaries.
- [x] Generates the monolingual dictionary files.
CONTRIBUTION
------------
The work flow is the same as that of any other repository.
1.Fork / clone the repository.
2.Create a new branch , say `my-changes` and make your changes in this branch.
3.Commit your changes and send a Pull request (PR) to this repository.
Active contributors would be rewarded with the tag of "Collabrators".
Bug fixes , Issues , Issue solutions , Optimizations & Enhancements are always welcome.
LICENSE
-------
The GNU GENERAL PUBLIC LICENSE - [Abinash Senapati](http://github.com/Techievena) - All Rights Reserved.
ACKNOWLEDGEMENTS
----------------
I would like to thank mentors at [Apertium](https://github.com/Apertium) for helping me with the development and maintenance of this package.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
lexc2dix-1.0.tar.gz
(21.2 kB
view hashes)
Built Distributions
lexc2dix-1.0-py3.6.egg
(14.8 kB
view hashes)
lexc2dix-1.0-py2.py3-none-any.whl
(10.7 kB
view hashes)
Close
Hashes for lexc2dix-1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2cf73190665aa9b7532d45bf8fa046fcb36a9d323a9db861f7bda7b16db2743 |
|
MD5 | 23a27ad32439550b32783a789c764bdc |
|
BLAKE2b-256 | 0399db241e3bbf46279b7d8665637f60f9f9f44bfa4f5f1392130a982ea14f05 |