Metadata-Version: 2.0
Name: abydos
Version: 0.2.0
Summary: Abydos NLP/IR library
Home-page: https://github.com/chrislit/abydos
Author: Chris Little
Author-email: chrisclittle+abydos@gmail.com
License: GPLv3+
Download-URL: https://github.com/chrislit/abydos/archive/master.zip
Keywords: nlp,ai,ir,language,linguistics,phonetic algorithms,string distance
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Natural Language :: English
Requires-Dist: numpy

Abydos
======

.. image:: https://travis-ci.org/chrislit/abydos.svg
    :target: https://travis-ci.org/chrislit/abydos
    :alt: Build Status

.. image:: https://coveralls.io/repos/chrislit/abydos/badge.svg
    :target: https://coveralls.io/r/chrislit/abydos
    :alt: Coverage Status

.. image:: https://codeclimate.com/github/chrislit/abydos/badges/gpa.svg
   :target: https://codeclimate.com/github/chrislit/abydos
   :alt: Code Climate

.. image:: https://img.shields.io/badge/Pylint-9.99/10-green.svg
    :alt: Pylint Score

.. image:: https://img.shields.io/badge/PEP8-0-brightgreen.svg
    :alt: PEP8 Errors

.. image:: https://img.shields.io/pypi/v/abydos.svg
    :target: https://pypi.python.org/pypi/abydos
    :alt: PyPI

.. image:: https://readthedocs.org/projects/abydos/badge/?version=latest
    :target: https://abydos.readthedocs.org/en/latest/
    :alt: Documentation Status

.. image:: https://www.openhub.net/p/abydosnlp/widgets/project_thin_badge.gif
    :target: https://www.openhub.net/p/abydosnlp
    :alt: OpenHUB

|

.. image:: https://raw.githubusercontent.com/chrislit/abydos/master/abydos-small.png
    :alt: abydos
    :align: right

|
| Abydos NLP/IR library
| Copyright 2014-2015 by Chris Little

This library contains code I'm using for research, in particular dissertation research & experimentation.

Required:

- Numpy


Recommended:

- PylibLZMA   (Python 2 only--for LZMA compression string distance metric)

Suggested for testing & QA:

- Nose        (for unit testing)
- coverage.py (for code coverage checking)
- Pylint      (for code quality checking)
- PEP8        (for code quality checking)

-----

To build/install/unittest in Python 2:

::

    sudo python setup.py install
    nosetests -v --with-coverage --cover-erase --cover-html --cover-branches --cover-package=abydos .

To build/install/unittest in Python 3:

::

    sudo python3 setup.py install
    nosetests3 -v --with-coverage --cover-erase --cover-html --cover-branches --cover-package=abydos .

For pylint testing, run:

::

    pylint --rcfile=pylint.rc abydos > pylint.log


Release History
---------------

0.2 (2015-05-27)
++++++++++++++++++

- Added Caumanns' German stemmer
- Added Lovins' English stemmer
- Added basic docs via Sphinx
- Updated Beider-Morse Phonetic Matching to 3.04
- added Sphinx documentation


0.1.1 (2015-05-12)
++++++++++++++++++

- First Beta release to PyPI



Authors
```````

- Chris Little (`@chrislit <https://github.com/chrislit>`_) <chrisclittle+abydos@gmail.com>


