Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seanghay committed Jul 19, 2023
1 parent b6d033a commit 5ff9f36
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Seanghay

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
10 changes: 9 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Khmer Normalizer
## Khmer Normalizer

A missing toolkit for **Khmer Natural Language Processing**.

Expand All @@ -14,6 +14,14 @@ A missing toolkit for **Khmer Natural Language Processing**.
- Quotes symbols normalization
- Remove repeated punctuations

### Installation

```shell
pip install khmernormalizer
```

### Usage

```python
from khmernormalizer import normalize

Expand Down
14 changes: 12 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import setuptools
import khmernormalizer

with open("readme.md") as f:
with open("README.md", "r") as f:
readme_md = f.read()

setuptools.setup(
Expand All @@ -10,13 +10,23 @@
description="A missing toolkit for Khmer Natural Language Processing.",
long_description=readme_md,
long_description_content_type="text/markdown",
url="https://github.com/seanghay/khmernormalizer",
author="Seanghay Yath",
author_email="[email protected]",
packages=["khmernormalizer"],
classifiers=[],
package_dir={"khmernormalizer": "khmernormalizer"},
classifiers=[
"Programming Language :: Python :: 3",
"Operating System :: OS Independent",
"Intended Audience :: Developers",
"Natural Language :: English",
],
install_requires=[
"regex",
"emoji==2.6.0",
"ftfy==6.1.1"
],
package_data={'': ["*"]},
include_package_data=True,
python_requires='>=3.5'
)

0 comments on commit 5ff9f36

Please sign in to comment.