Skip to main content

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)


Project details


Download files

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

Files for py-processors, version 3.2.2
Filename, size File type Python version Upload date Hashes
Filename, size py_processors-3.2.2-py2.py3-none-any.whl (45.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size py-processors-3.2.2.tar.gz (50.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page