Metadata-Version: 2.1
Name: light-aligner
Version: 0.1.0
Summary: a light-weight aligner.
Home-page: https://github.com/ffreemt/light-aligner
Author: ffreemt
Requires-Python: >=3.6.1,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: absl-py (>=0.9.0,<0.10.0)
Requires-Dist: blinker (>=1.4,<2.0)
Requires-Dist: cchardet (>=2.1.6,<3.0.0)
Requires-Dist: chardet (>=3.0.4,<4.0.0)
Requires-Dist: diskcache (>=4.1.0,<5.0.0)
Requires-Dist: flake8 (>=3.8.3,<4.0.0)
Requires-Dist: jinja2 (>=2.11.2,<3.0.0)
Requires-Dist: langid (>=1.1.6,<2.0.0)
Requires-Dist: linetimer (>=0.1.4,<0.2.0)
Requires-Dist: logzero (>=1.5.0,<2.0.0)
Requires-Dist: matplotlib (>=3.3.0,<4.0.0)
Requires-Dist: msgpack (>=1.0.0,<2.0.0)
Requires-Dist: openpyxl (>=3.0.4,<4.0.0)
Requires-Dist: orjson (>=3.3.0,<4.0.0)
Requires-Dist: pandas (>=1.1.0,<2.0.0)
Requires-Dist: polyglot (>=16.7.4,<17.0.0)
Requires-Dist: rank_bm25 (>=0.2.1,<0.3.0)
Requires-Dist: seaborn (>=0.10.1,<0.11.0)
Requires-Dist: sentence-splitter (>=1.4,<2.0)
Requires-Dist: textblob (>=0.15.3,<0.16.0)
Requires-Dist: ujson (>=3.1.0,<4.0.0)
Requires-Dist: xlrd (>=1.2.0,<2.0.0)
Requires-Dist: yaspin (>=1.0.0,<2.0.0)
Project-URL: Repository, https://github.com/ffreemt/light-aligner
Description-Content-Type: text/markdown

# Light-Aligner ![build](https://github.com/ffreemt/light-aligner/workflows/build/badge.svg)
A light-weight aligner for dual-texts (currently just English-Chinese) based on similariy scores using word for word "translation"

## Features
* Fast
* Low resources demand
* No internet required

## Special Dependencies
Light-Aligner depends on polyglot that depends on `libicu`

To install `libicu`
###### For Linux/OSX

E.g.
* Ubuntu: `sudo apt install libicu-dev`
* Centos: `yum install libicu`
* OSX: `brew install icu4c`

Then use `poetry` or `pip` to install ` PyICU pycld2 Morfessor`, e.g.
```
poetry add PyICU pycld2 Morfessor
```
or
```
pip install PyICU pycld2 Morfessor
```
###### For Windows

Download and install the `pyicu` and `pycld2` (possibly also `Morfessor`) whl packages for your OS/Python version from https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyicu and https://www.lfd.uci.edu/~gohlke/pythonlibs/#pycld2 (possibly also Morfessor https://www.lfd.uci.edu/~gohlke/pythonlibs/)

### Installation
```pip install light-aligner``` (Not yet ready)
or
Clone the repo and install necessary packages using `pip`:
```
git clone git@github.com:ffreemt/light-aligner.git
cd light-aigner
pip install -r requirements.txt
```
or
Clone the repo and install necessary packages using `poetry`
```
git clone git@github.com:ffreemt/light-aligner.git
cd light-aigner
poetry install -v
```
This also works in `Linux/OSX`. In fact, the build process in github (pertaining to that github workflow badge ![build](https://github.com/ffreemt/light-aligner/workflows/build/badge.svg)) is carried out in Linux.


### Usage

```
cd light-aligner
python -m light-aligner
```

You may wish to use powershell (e.g., right click the powershell script`run-python-m.ps1` and select `Run with Powershell`) or conemu or cmder for better visual terminal experience.

Join qq-group 316287378 if you have any questions. The group chat is normally in Chinese but can be switched to English i fso desired.

