Upload 7 files

.gitignore

@@ -0,0 +1,43 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+hidden/
+__pycache__/
+*.pyc 
+build/
+klpt.egg-info/
+site/
+cinder/
+.vscode/
+# End of https://www.toptal.com/developers/gitignore/api/macos
+

LICENSE

@@ -0,0 +1,108 @@
+Attribution-ShareAlike 4.0 International Public License (https://creativecommons.org/licenses/by-sa/4.0/)
+Copyright (c) 2020
+
+Sina Ahmadi (ahmadi.sina@outlook.com)
+=======================================================================
+Creative Commons Attribution-ShareAlike 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+Section 1 – Definitions.
+
+    Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+    Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+    BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
+    Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+    Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+    Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+    License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
+    Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+    Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+    Licensor means the individual(s) or entity(ies) granting rights under this Public License.
+    Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+    Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+    You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+Section 2 – Scope.
+
+    License grant.
+        Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+            reproduce and Share the Licensed Material, in whole or in part; and
+            produce, reproduce, and Share Adapted Material.
+        Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+        Term. The term of this Public License is specified in Section 6(a).
+        Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+        Downstream recipients.
+            Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+            Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
+            No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+        No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+
+    Other rights.
+        Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+        Patent and trademark rights are not licensed under this Public License.
+        To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+
+    Attribution.
+
+        If You Share the Licensed Material (including in modified form), You must:
+            retain the following if it is supplied by the Licensor with the Licensed Material:
+                identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+                a copyright notice;
+                a notice that refers to this Public License;
+                a notice that refers to the disclaimer of warranties;
+                a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+            indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+            indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+        You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+        If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+    ShareAlike.
+
+    In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
+        The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
+        You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
+        You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
+
+Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+
+    for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+    if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
+    You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+    Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
+    To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
+
+    The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+Section 6 – Term and Termination.
+
+    This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+
+    Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+        automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+        upon express reinstatement by the Licensor.
+    For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+    For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+    Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+Section 7 – Other Terms and Conditions.
+
+    The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+    Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+Section 8 – Interpretation.
+
+    For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+    To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+    No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+    Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

MANIFEST.in

@@ -0,0 +1,18 @@
+include klpt/data/ckb-Arab.aff
+include klpt/data/ckb-Arab.dic
+include klpt/data/ckb-morphemes.json
+include klpt/data/default-options.json
+include klpt/data/kmr-morphemes.json
+include klpt/data/lexicon_ckb_arab.json
+include klpt/data/lexicon_ckb_latn.json
+include klpt/data/lexicon_kmr_latn.json
+include klpt/data/preprocess_map.json
+include klpt/data/stopwords.json
+include klpt/data/test_cases_stem.json
+include klpt/data/test_cases_tokenize.json
+include klpt/data/test_cases.json
+include klpt/data/tokenize.json
+include klpt/data/wergor.json
+include klpt/data/kmr-Latn.att
+include klpt/data/kmr-Latn.aff
+include klpt/data/kmr-Latn.dic

README.md

@@ -1,3 +1,350 @@
----
-license: mit
----
+# Kurdish Language Processing Toolkit
+
+<p align="center" width="100%">
+    <img width="33%" src="https://raw.githubusercontent.com/sinaahmadi/klpt/master/docs/img/KLPT_logo.png"> 
+</p>
+
+<p align="center">
+    <a href="">
+        <img alt="Build" src="https://badges.frapsoft.com/os/v1/open-source.png?v=103">
+    </a>
+    <a href="https://github.com/sinaahmadi/KLPT/blob/master/license">
+        <img alt="GitHub" src="https://img.shields.io/badge/license-CC%20BY--SA%204.0-blue">
+    </a>
+    <a href="">
+        <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/klpt">
+    </a>
+    <a href="https://sinaahmadi.github.io/klpt/">
+        <img alt="Documentation" src="https://img.shields.io/website?down_color=green&down_message=online&up_color=orange&url=https%3A%2F%2Fsinaahmadi.github.io%2FKLPT%2F">
+    </a>
+    <a href="https://gitter.im/KurdishNLP/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
+      <img alt="Documentation" src="https://badges.gitter.im/KurdishNLP/community.svg">
+    </a>
+    <a href="https://badge.fury.io/py/klpt">
+        <img src="https://badge.fury.io/py/klpt.svg" alt="PyPI version" height="18">
+    </a>
+</p>
+
+
+### Welcome / *Hûn bi xêr hatin* / بە خێر بێن! 🙂
+
+Kurdish Language Processing Toolkit--KLPT is a [natural language processing](https://en.wikipedia.org/wiki/Natural_language_processing) (NLP) toolkit in Python for the [Kurdish language](https://en.wikipedia.org/wiki/Kurdish_languages). The current version comes with four core modules, namely `preprocess`, `stem`, `transliterate` and `tokenize` and addresses basic language processing tasks such as text preprocessing, stemming, tokenization, spell-checking and morphological analysis for the [Sorani](https://en.wikipedia.org/wiki/Sorani) and the [Kurmanji](https://en.wikipedia.org/wiki/Kurmanji) dialects of Kurdish.
+
+---
+#### Latest update on April 29th, 2022 🎉
+
+In the latest version, I focused on Kurmanji for which a morphological analyzer, a stemmer and a lemmatizer are now added to the toolkit. These tasks were partially addressed previously using the [Apertium project](https://github.com/apertium/apertium-kmr). Now, that is fully replaced by the Kurmanji implementation of [Kurdish Hunspell](https://github.com/sinaahmadi/KurdishHunspell). 
+
+---
+
+## Install KLPT
+
+<!--For detailed installation instructions, see the [documentation]().-->
+
+- **Operating system**: macOS / OS X · Linux · Windows (Cygwin, MinGW, Visual
+  Studio)
+- **Python version**: Python 3.5+ 
+- **Package managers**: [pip](https://pypi.org/project/klpt/)
+
+[pip]: https://pypi.org/project/spacy/
+[conda]: https://anaconda.org/conda-forge/spacy
+
+### pip
+
+Using pip, KLPT releases are available as source packages and binary wheels. Please make sure that a compatible Python version is installed:
+
+```bash
+pip install klpt
+```
+
+All the data files including lexicons and morphological rules are also installed with the package. 
+
+Although KLPT is not dependent on any NLP toolkit, there is one important requirement, particularly for the `stem` module. That is [`cyhunspell`](https://pypi.org/project/cyhunspell/) which should be installed with a version >= 2.0.1.
+
+### About this version
+
+Please note that KLPT is under development and some of the functionalities will appear in the future versions. You can find out regarding the progress of each task at the [Projects](https://github.com/sinaahmadi/KLPT/projects) section. In the current version, the following tasks are included:
+
+<table>
+<thead>
+  <tr>
+    <th>Modules<br></th>
+    <th>Tasks</th>
+    <th>Sorani (ckb)</th>
+    <th>Kurmanji (kmr)</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td rowspan="4"><code>preprocess</code></td>
+    <td>normalization</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>standardization</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>unification of numerals</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>stopwords</td>
+    <td>&#10003; (v0.1.4)</td>
+    <td>&#10003; (v0.1.4)</td>
+  </tr>
+  <tr>
+    <td rowspan="4"><code>tokenize</code></td>
+    <td>word tokenization<br></td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>MWE tokenization<br></td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>sentence tokenization</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>part-of-speech tagging</td>
+    <td>&#x2717;</td>
+    <td>&#x2717;</td>
+  </tr>
+  <tr>
+    <td rowspan="4"><code>transliterate</code></td>
+    <td>Arabic to Latin</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>Latin to Arabic</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>Detection of u/w and î/y</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.0)</td>
+  </tr>
+  <tr>
+    <td>Detection of Bizroke ( <i>i</i> )</td>
+    <td>&#x2717;</td>
+    <td>&#x2717;</td>
+  </tr>
+  <tr>
+    <td rowspan="5"><code>stem</code></td>
+    <td>morphological analysis</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v0.1.1)</td>
+  </tr>
+  <tr>
+    <td>stemming</td>
+    <td>&#10003; (v.0.1.5)</td>
+    <td>&#10003; (v.0.1.6) 🆕</td>
+  </tr>
+  <tr>
+    <td>lemmatization</td>
+    <td>&#10003; (v.0.1.5)</td>
+    <td>&#10003; (v.0.1.6) 🆕</td>
+  </tr>
+  <tr>
+    <td>spell error detection and correction</td>
+    <td>&#10003; (v0.1.0)</td>
+    <td>&#10003; (v.0.1.6) 🆕</td>
+  </tr>
+</tbody>
+</table>
+
+
+## Basic usage
+
+Once the package is installed, you can import the toolkit as follows:
+
+```python
+import klpt
+```
+
+In the following, a few examples are provided to work with various modules. Almost all the classes have three arguments in common:
+
+- `dialect`: the name of the dialect as `Sorani` or `Kurmanji` (ISO 639-3 code will be also added)
+- `script`: the script of your input text as "Arabic" or "Latin"
+- `numeral`: the type of the numerals as
+	- Arabic [١٢٣٤٥٦٧٨٩٠]
+	- Farsi [۱۲۳۴۵۶۷۸۹۰]
+	- Latin [1234567890]
+
+### Preprocess
+
+This module deals with normalizing scripts and orthographies by using writing conventions based on dialects and scripts. The goal is not to correct the orthography but to normalize the text in terms of the encoding and common writing rules. The input encoding should be in UTF-8 only. To this end, three functions are provided as follows:
+
+- `normalize`: deals with different encodings and unifies characters based on dialects and scripts
+- `standardize`: given a normalized text, it returns standardized text based on the Kurdish orthographies following recommendations for [Kurmanji](https://books.google.ie/books?id=Z7lDnwEACAAJ) and [Sorani](http://yageyziman.com/Renusi_Kurdi.htm)
+- `unify_numerals`: conversion of the various types of numerals used in Kurdish texts
+- `preprocess`: one single function for normalization, standardization and unification of numerals
+
+It is recommended that the output of this module be used as the input of subsequent tasks in an NLP pipeline.
+
+```python
+>>> from klpt.preprocess import Preprocess
+
+>>> preprocessor_ckb = Preprocess("Sorani", "Arabic", numeral="Latin")
+>>> preprocessor_ckb.normalize("لە ســـاڵەکانی ١٩٥٠دا")
+'لە ساڵەکانی 1950دا'
+>>> preprocessor_ckb.standardize("راستە لەو ووڵاتەدا")
+'ڕاستە لەو وڵاتەدا'
+>>> preprocessor_ckb.unify_numerals("٢٠٢٠")
+'2020'
+>>> preprocessor_ckb.preprocess("راستە لە ووڵاتەی ٢٣هەمدا")
+'ڕاستە لە وڵاتەی 23هەمدا'
+
+>>> preprocessor_kmr = Preprocess("Kurmanji", "Latin")
+>>> preprocessor_kmr.standardize("di sala 2018-an")
+'di sala 2018an'
+>>> preprocessor_kmr.standardize("hêviya")
+'hêvîya'
+```
+
+In addition, it is possible to remove Kurdish [stopwords](https://en.wikipedia.org/wiki/Stop_word) using the `stopwords` variable. You can define a function like the following to do so:
+
+```python
+from klpt.preprocess import Preprocess
+
+def remove_stopwords(text, dialect, script):
+    p = Preprocess(dialect, script)
+    return [token for token in text.split() if token not in p.stopwords]
+```
+
+### Tokenization
+
+This module focuses on the tokenization of both Kurmanji and Sorani dialects of Kurdish with the following functions:
+
+- `word_tokenize`: tokenization of texts into tokens (both [multi-word expressions](https://aclweb.org/aclwiki/Multiword_Expressions) and single-word tokens).
+- `mwe_tokenize`: tokenization of texts by only taking compound forms into account
+- `sent_tokenize`: tokenization of texts into sentences
+
+This module is based on the [Kurdish tokenization project](https://github.com/sinaahmadi/KurdishTokenization). It is recommended that the output of this module be used as the input of the `Stem` module. 
+
+```python
+>>> from klpt.tokenize import Tokenize
+
+>>> tokenizer = Tokenize("Kurmanji", "Latin")
+>>> tokenizer.word_tokenize("ji bo fortê xwe avêtin")
+['▁ji▁', 'bo', '▁▁fortê‒xwe‒avêtin▁▁']
+>>> tokenizer.mwe_tokenize("bi serokê hukûmeta herêma Kurdistanê Prof. Salih re saz kir.")
+'bi serokê hukûmeta herêma Kurdistanê Prof . Salih re saz kir .'
+
+>>> tokenizer_ckb = Tokenize("Sorani", "Arabic")
+>>> tokenizer_ckb.word_tokenize("بە هەموو هەمووانەوە ڕێک کەوتن")
+['▁بە▁', '▁هەموو▁', 'هەمووانەوە', '▁▁ڕێک‒کەوتن▁▁']
+```
+
+### Transliteration
+
+This module aims at transliterating one script of Kurdish into another one. Currently, only the Latin-based and the Arabic-based scripts of Sorani and Kurmanji are supported. The main function in this module is `transliterate()` which also takes care of detecting the correct form of double-usage graphemes, namely و ↔ w/u and ی ↔ î/y. In some specific occasions, it can also predict the placement of the missing *i* (also known as *Bizroke/بزرۆکە*).
+
+The module is based on the [Kurdish transliteration project](https://github.com/sinaahmadi/wergor).
+
+```python
+>>> from klpt.transliterate import Transliterate
+>>> transliterate = Transliterate("Kurmanji", "Latin", target_script="Arabic")
+>>> transliterate.transliterate("rojhilata navîn")
+'رۆژهلاتا ناڤین'
+
+>>> transliterate_ckb = Transliterate("Sorani", "Arabic", target_script="Latin")
+>>> transliterate_ckb.transliterate("لە وڵاتەکانی دیکەدا")
+'le wiłatekanî dîkeda'
+```
+
+### Stem
+
+The Stem module deals with various tasks, mainly through the following functions:
+- `check_spelling`: spell error detection
+- `correct_spelling`: spell error correction
+- `analyze`: morphological analysis
+- `stem`: stemming, e.g. "بڕ" → "بڕاوە" or "dixwî" → "xw"
+- `lemmatize`: lemmatization, e.g. "بردن" → "بردمنەوە" or "jimartibûye" → "hejmartin"
+
+The module is based on the [Kurdish Hunspell project](https://github.com/sinaahmadi/KurdishHunspell) for Sorani and the [Apertium project](https://github.com/apertium/apertium-kmr) for Kurmanji. Please note that this module is currently getting further completed and we are aware of its current shortcomings.
+
+```python
+>>> from klpt.stem import Stem
+>>> stemmer = Stem("Sorani", "Arabic")
+>>> stemmer.check_spelling("سوتاندبووت")
+False
+>>> stemmer.correct_spelling("سوتاندبووت")
+(False, ['ستاندبووت', 'سووتاندبووت', 'سووڕاندبووت', 'ڕووتاندبووت', 'فەوتاندبووت', 'بووژاندبووت'])
+>>> stemmer.analyze("دیتبامن")
+[{'pos': ['verb'], 'description': 'past_stem_transitive_active', 'stem': 'دی', 'lemma': ['دیتن'], 'base': 'دیت', 'prefixes': '', 'suffixes': 'بامن'}]
+>>> stemmer.stem("دەچینەوە")
+['چ']
+>>> stemmer.stem("گورەکە", mark_unknown=True) # گوڵەکە in Hewlêrî dialect
+['_گور_']
+>>> stemmer.lemmatize("گوڵەکانم")
+['گوڵ', 'گوڵە']
+
+>>> stemmer = Stem("Kurmanji", "Latin")
+>>> stemmer.analyze("dibêjim")
+[{'base': 'bêj', 'prefixes': 'di', 'suffixes': 'im', 'pos': ['verb'], 'description': 'present_stem_transitive_active', 'stem': 'bêj', 'lemma': ['gotin']}]
+>>> stemmer.stem("dixwî")
+['xw']
+>>> stemmer.lemmatize("jimartibûye")
+['hejmartin']
+```
+
+📖 **Please note that a more complete documentation of the toolkit is available at [https://sinaahmadi.github.io/klpt/](https://sinaahmadi.github.io/klpt/)**.
+
+## Become a sponsor 
+
+Please consider donating to the project. Data annotation and resource creation requires tremendous amount of time and linguistic expertise. Even a trivial donation will make a difference. You can do so by [becoming a sponsor](https://github.com/sponsors/sinaahmadi) to accompany me in this journey and help the Kurdish language have a better place within other natural languages on the Web. Depending on your support,
+
+- You can be an official sponsor
+- You will get a GitHub sponsor badge on your profile
+- If you have any questions, I will focus on it
+- If you want, I will add your name or company logo on the front page of your preferred project
+- Your contribution will be acknowledged in one of my future papers in a field of your choice
+
+*And, thanks for those who have already sponsored this project. More significant achievements will be made thanks to you!*
+
+## Contribute
+
+Are you interested in this project? Each task is addressed individually. Please check the following repositories to find which one you are more interested in:
+
+- [Kurdish tokenization](https://github.com/sinaahmadi/KurdishTokenization)
+- [Kurdish Hunspell](https://github.com/sinaahmadi/KurdishHunspell)
+- [Kurdish transliteration](https://github.com/sinaahmadi/wergor)
+
+In addition, our main objective is to extend the current toolkit to include more tasks, particularly part-of-speech tagging, named-entity recognition and syntactic analysis. Further instructions are provided at [https://sinaahmadi.github.io/klpt/about/contributing/](https://sinaahmadi.github.io/klpt/about/contributing/). You can also join us on [Gitter](https://gitter.im/KurdishNLP/community).
+
+Don't forget, **open-source is fun!** 😊
+
+## Requirements
+- Python >=3.6
+- [`cyhunspell`](https://pypi.org/project/cyhunspell/) >= 2.0.1
+
+## Cite this project
+Please consider citing [this paper](https://sinaahmadi.github.io/docs/articles/ahmadi2020klpt.pdf), if you use any part of the data or the tool ([`bib` file](https://sinaahmadi.github.io/bibliography/ahmadi2020klpt.txt)):
+
+	@inproceedings{ahmadi2020klpt,
+	    title = "{KLPT--Kurdish Language Processing Toolkit}",
+	    author = "Ahmadi, Sina",
+	    booktitle = "Proceedings of the second Workshop for {NLP} Open Source Software ({NLP}-{OSS})",
+	    month = nov,
+	    year = "2020",
+	    publisher = "Association for Computational Linguistics"
+	}
+
+
+## License 
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">Kurdish Language Processing Toolkit</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/sinaahmadi/klpt" property="cc:attributionName" rel="cc:attributionURL">Sina Ahmadi</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a> which means:
+
+- **You are free to share**, copy and redistribute the material in any medium or format and also adapt, remix, transform, and build upon the material
+for any purpose, **even commercially**. 
+- **You must give appropriate credit**, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+- If you remix, transform, or build upon the material, **you must distribute your contributions under the same license as the original**.

mkdocs.yml

@@ -0,0 +1,37 @@
+use_directory_urls: true
+site_name: KLPT
+site_url: https://sinaahmadi.github.io/klpt/
+site_description: "Kurdish Language Processing Toolkit"
+site_author: Sina Ahmadi
+copyright: <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">Kurdish Language Processing Toolkit</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/sinaahmadi/klpt" property="cc:attributionName" rel="cc:attributionURL">Sina Ahmadi</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>
+
+repo_url: "https://github.com/sinaahmadi/klpt"
+
+theme:
+  name: null
+  custom_dir: cinder
+  colorscheme: dracula
+  highlightjs: true
+  hljs_languages:
+      - python
+      - json
+
+nav:
+    - Home: index.md
+    - User Guide:
+        - Getting started: user-guide/getting-started.md
+        - Preprocess: user-guide/preprocess.md
+        - Tokenize: user-guide/tokenize.md
+        - Transliterate: user-guide/transliterate.md
+        - Stem: user-guide/stem.md
+    - About:
+        - Release Notes: about/release-notes.md
+        - Contributing: about/contributing.md
+        - Sponsors: about/sponsors.md
+        - License: about/license.md
+
+plugins:
+  - search
+  - mkdocstrings
+  - git-revision-date
+

requirements.txt

@@ -0,0 +1 @@
+chunspell==2.0.4

setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup, find_packages
+from os import path
+
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding = "utf-8") as f:
+    long_description = f.read()
+
+with open('requirements.txt', encoding = "utf-8") as f:
+    required = [req.strip() for req in f.read().splitlines() if req.strip()]
+
+setup(
+    name="klpt",
+    version="0.1.6",
+    description="Kurdish Language Processing Toolkit",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Sina Ahmadi",
+    author_email="ahmadi.sina@outlook.com",
+    url="https://github.com/sinaahmadi/klpt",
+    packages=find_packages(exclude=["tests", "cinder"]),
+    license="CC BY-SA 4.0",
+    install_requires=required,
+    include_package_data=True,
+    python_requires=">=3.6"
+)