Metadata-Version: 2.1
Name: finntk
Version: 0.0.27
Summary: Finnish NLP toolkit
Home-page: https://github.com/frankier/finntk
Author: Frankie Robertson
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: docs
Requires-Dist: more-itertools (>=4.1.0)
Requires-Dist: pyahocorasick (>=1.1.8)
Requires-Dist: appdirs (>=1.4.3)
Requires-Dist: plumbum (>=1.6.6)
Requires-Dist: nltk (>=3.3)
Requires-Dist: gensim (>=3.4.0)
Requires-Dist: smart-open (>=1.7.1)
Requires-Dist: portalocker (>=>1.2.1)
Requires-Dist: scikit-learn (>=0.19.2)
Requires-Dist: wordfreq (>=2.2.0)
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: hypothesis; extra == 'dev'
Requires-Dist: twine (>=1.11.0); extra == 'dev'
Requires-Dist: wheel (>=0.31.0); extra == 'dev'
Requires-Dist: setuptools (>=38.6.0); extra == 'dev'
Requires-Dist: flake8 (>=3.5.0); extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx (>=1.5); extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Requires-Dist: pytest-check-links; extra == 'docs'
Requires-Dist: recommonmark; extra == 'docs'

# FinnTK

<p align="center">
<a href="https://badge.fury.io/py/finntk"><img src="https://badge.fury.io/py/finntk.svg" alt="Available on PyPI" height="18"></a>
<a href="https://finntk.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/finntk/badge/?version=latest"></a>
</p>

Some simple high level tools for processing Finnish text.

This project is according to my personal preferences but might be
helpful to others, particularly for exploratory coding. For larger projects you may prefer to use [OMorFi](https://github.com/flammie/omorfi) directly.

## Installation ##

This project assumes you've installed HFST and OMorFi system-wide, like so:

  $ PIP_IGNORE_INSTALLED=1 pipenv install --site-packages finntk

Part of the reason for this is because [HFST is not currently pip installable](https://github.com/hfst/hfst/issues/375).

The current known good versions of HFST and OMorFi are in installed with Docker in the `docker` directory.

## License ##

This project is licensed under the Apache v2 license. The code in
`finntk/vendor` is vendorized from other projects and is licensed under their
respective licenses.

## Development ##

### Release process ###

1. Make a release commit in which the version is incremented in setup.py

2. Make a git tag of this commit with `git tag v$VERSION`

3. Push release to GitHub with `git push --tags`

4. Upload to PyPI with `python3 setup.py sdist bdist_wheel` and `twine upload dist/*`


