first commit

Author: hkiyomaru

.gitignore

@@ -0,0 +1,107 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# pycharm
+.idea/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Kurohashi-Kawahara lab, Kyoto University
+
+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.

MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+graft tests
+global-exclude __pycache__
+global-exclude *.py[co]

README.md

@@ -0,0 +1,29 @@
+# python-textformatting
+
+## Requirements
+
+- Python 3.6.8
+
+## Installation
+
+```
+$ python setup.py install
+```
+
+## Example
+
+```python
+from textformatting import ssplit
+
+text = "日本語のテキストを文単位に分割します。Pythonで書かれています。"
+sentences = ssplit(text)  # ['日本語のテキストを文単位に分割します。', 'Pythonで書かれています。']
+```
+
+## License
+
+- MIT
+
+## Authors
+
+- Kyoto University (contact [at] nlp.ist.i.kyoto-u.ac.jp)
+  - Hirokazu Kiyomaru

setup.cfg

@@ -0,0 +1,5 @@
+[aliases]
+test=pytest
+
+[tool:pytest]
+addopts = --verbose

setup.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+import io
+import os
+
+from setuptools import find_packages, setup
+
+# package meta data
+NAME = 'textformatting'
+DESCRIPTION = 'A Japanese text formatter'
+EMAIL = 'contact@nlp.ist.i.kyoto-u.ac.jp'
+AUTHOR = 'Kurohashi-Kawahara Lab, Kyoto University'
+VERSION = ''
+
+INSTALL_REQUIRES = []
+
+SETUP_REQUIRES = [
+    'pytest-runner'
+]
+
+TEST_REQUIRES = [
+    'pytest==4.6.5'
+]
+
+here = os.path.abspath(os.path.dirname(__file__))
+with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = '\n' + f.read()
+
+about = {}
+with io.open(os.path.join(here, NAME, '__version__.py'), encoding='utf-8') as f:
+    exec(f.read(), about)
+
+setup(
+    name=NAME,
+    version=about['__version__'],
+    description=DESCRIPTION,
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    author=AUTHOR,
+    author_email=EMAIL,
+    packages=find_packages(exclude=('tests',)),
+    install_requires=INSTALL_REQUIRES,
+    setup_requires=SETUP_REQUIRES,
+    tests_require=TEST_REQUIRES,
+    license='MIT',
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python'
+    ]
+)

tests/test_ssplit.py

@@ -0,0 +1,35 @@
+import glob
+import json
+import typing
+
+import os
+import pytest
+
+from textformatting import ssplit
+
+
+def read_test_file(path):
+    """Read a test file.
+
+    Parameters
+    ----------
+    path : str
+        The path to a test file.
+
+    Returns
+    -------
+    typing.Tuple[str, typing.List[str]]
+    """
+    with open(path) as f:
+        dct = json.load(f)
+        return dct['text'], dct['sentences']
+
+
+test_file_path_pattern = os.path.join(os.path.dirname(__file__), 'test_ssplit', '*.json')
+test_cases = [read_test_file(path) for path in sorted(glob.glob(test_file_path_pattern))]
+
+
+@pytest.mark.parametrize('test_case', test_cases)
+def test_ssplit(test_case):
+    text, sentences = test_case
+    assert ssplit(text) == sentences

tests/test_ssplit/000.json

@@ -0,0 +1,7 @@
+{
+  "text": "日本語のテキストを文単位に分割します。Pythonで書かれています。",
+  "sentences": [
+    "日本語のテキストを文単位に分割します。",
+    "Pythonで書かれています。"
+  ]
+}

tests/test_ssplit/001.json

@@ -0,0 +1,7 @@
+{
+  "text": "今何時ですか？次の予定があるので失礼します。",
+  "sentences": [
+    "今何時ですか？",
+    "次の予定があるので失礼します。"
+  ]
+}

tests/test_ssplit/002.json

@@ -0,0 +1,7 @@
+{
+  "text": "お疲れ様です！次の予定があるので失礼します。",
+  "sentences": [
+    "お疲れ様です！",
+    "次の予定があるので失礼します。"
+  ]
+}