py-processors 2.9

[](http://py-processors.readthedocs.io/en/latest/?badge=latest) [](https://travis-ci.org/myedibleenso/py-processors) [](https://scrutinizer-ci.com/g/myedibleenso/py-processors/?branch=master) [](https://coveralls.io/github/myedibleenso/py-processors?branch=master) [](https://requires.io/github/myedibleenso/py-processors/requirements/?branch=master) [](http://waffle.io/myedibleenso/py-processors)

# Contents
- [Text processors](processors.md)
- [Rule-based IE with Odin](odin.md)
- [Annotating text](processors.md#annotating-text)
- [A walkthrough example](example.md)
- [Running the tests](dev.md#running-the-tests)
- [FAQ](faq.md)
- [History](release-notes.md)

# What is it?
`py-processors` is a Python wrapper for the CLU Lab's [`processors`](http://github.com/clulab/processors) NLP library. `py-processors` relies on [`processors-server`](http://github.com/myedibleenso/processors-server).

Though [compatible*](https://github.com/myedibleenso/py-processors/issues?q=is%3Aopen+is%3Aissue+label%3Apython2.x) with Python 2.x, this library was developed with 3.x in mind.

# Requirements
- [Java 8](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html)
- [`processor-sever`](http://github.com/myedibleenso/processors-server) (v2.7)
- this dependency will be retrieved automatically during installation
- At least 2GB of RAM free for the server (I recommend 3GB)

# Installation

```bash
pip install git+https://github.com/myedibleenso/py-processors.git
```

# How to use it?

See [the walkthrough example](example.md#a-walkthrough-example)