Skip to main content
Help us improve Python packaging – donate today!

A wrapper for interacting with the CLU Lab's processors library.

Project Description

[![Documentation Status](https://readthedocs.org/projects/py-processors/badge/?version=latest)](http://py-processors.readthedocs.io/en/latest/?badge=latest) [![Pypi version](https://img.shields.io/pypi/v/py-processors.svg)](https://pypi.python.org/pypi/py-processors) [![Build Status](https://travis-ci.org/myedibleenso/py-processors.svg?branch=master)](https://travis-ci.org/myedibleenso/py-processors) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/myedibleenso/py-processors/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/myedibleenso/py-processors/?branch=master) [![Coverage Status](https://coveralls.io/repos/github/myedibleenso/py-processors/badge.svg?branch=master)](https://coveralls.io/github/myedibleenso/py-processors?branch=master) [![Requirements Status](https://requires.io/github/myedibleenso/py-processors/requirements.svg?branch=master)](https://requires.io/github/myedibleenso/py-processors/requirements/?branch=master)

# Contents
- [Text processors](processors.md)
- [Rule-based IE with Odin](odin.md)
- [Annotating text](processors.md#annotating-text)
- [API Reference](api.md)
- [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
The server component can be run either via `docker` or directly with `java`.

## Option 1
- [`docker`](https://www.docker.com/) and the [`myedibleenso/processors-server`](https://hub.docker.com/r/myedibleenso/processors-server/) container

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

# Installation

`py-processors` can be installed via `pip`. The library also has a `jupyter` extras module which adds widgets/visualizations to `juypter` notebooks.

### basic installation
```bash
pip install py-processors
```

### basic + `jupyter` notebook widgets
```bash
pip install py-processors[jupyter]
```

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

# How to use it?

See [the walkthrough example](example.md)


Release history Release notifications

This version
History Node

3.2.2

History Node

3.2.1

History Node

3.1.0

History Node

3.0.3

History Node

3.0.2

History Node

3.0.1

History Node

3.0.0

History Node

2.9.7

History Node

2.9.6

History Node

2.9.4

History Node

2.9.3

History Node

2.9.2

History Node

2.9.1

History Node

2.9

History Node

2.8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
py_processors-3.2.2-py2.py3-none-any.whl (45.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Oct 30, 2017
py-processors-3.2.2.tar.gz (50.9 kB) Copy SHA256 hash SHA256 Source None Oct 30, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page