https://github.com/mohitmun/sutime
Python bindings for SUTime, can run on heroku freetier
https://github.com/mohitmun/sutime
Last synced: about 1 month ago
JSON representation
Python bindings for SUTime, can run on heroku freetier
- Host: GitHub
- URL: https://github.com/mohitmun/sutime
- Owner: mohitmun
- License: gpl-3.0
- Created: 2017-08-04T15:15:39.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T20:47:40.000Z (about 4 years ago)
- Last Synced: 2025-02-27T04:50:05.281Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sutime
*Python wrapper for Stanford CoreNLP's [SUTime](http://nlp.stanford.edu/software/sutime.shtml) Java library*
dc
#### Build Status
#### Introduction
This library provides a simple access to SUTime functions in Python.
#### Installation
```bash
>> pip install sutime
>> # use package pom.xml to install all Java dependencies via Maven into ./jars
>> mvn dependency:copy-dependencies -DoutputDirectory=./jars
```
#### Example
```python
import os
import json
from sutime import SUTime
if __name__ == '__main__':
test_case = u'I need a desk for tomorrow from 2pm to 3pm'
jar_files = os.path.join(os.path.dirname(__file__), 'jars')
sutime = SUTime(jars=jar_files, mark_time_ranges=True)
print(json.dumps(sutime.parse(test_case), sort_keys=True, indent=4))
```
Result:
```json
[
{
"end": 26,
"start": 18,
"text": "tomorrow",
"type": "DATE",
"value": "2016-10-14"
},
{
"end": 42,
"start": 27,
"text": "from 2pm to 3pm",
"type": "DURATION",
"value": {
"begin": "T14:00",
"end": "T15:00"
}
}
]
```
Other examples can be found in the [test](https://github.com/FraBle/python-sutime/blob/master/sutime/test/test_sutime.py) directory.
#### Functions
```python
SUTime(jars=[], jvm_started=False, mark_time_ranges=False, include_range=False)
"""
jars: List of paths to the SUTime Java dependencies.
jvm_started: Optional attribute to specify if the JVM has already been
started (with all Java dependencies loaded).
mark_time_ranges: Optional attribute to specify CoreNLP property
sutime.markTimeRanges. Default is False.
"Tells sutime to mark phrases such as 'From January to March'
instead of marking 'January' and 'March' separately"
include_range: Optional attribute to specify CoreNLP property
sutime.includeRange. Default is False.
"Tells sutime to mark phrases such as 'From January to March'
instead of marking 'January' and 'March' separately"
"""
sutime.parse(input_str, reference_date=''):
"""Parses datetime information out of string input.
It invokes the SUTimeWrapper.annotate() function in Java.
Args:
input_str: The input as string that has to be parsed.
reference_date: Optional reference data for SUTime.
Returns:
A list of dicts with the result from the SUTimeWrapper.annotate()
call.
Raises:
RuntimeError: An error occurres when CoreNLP is not loaded.
"""
```
#### Future Work
- fixing all upcoming bug reports and issues.
#### Credit
- [The team behind Stanford CoreNLP](http://stanfordnlp.github.io/CoreNLP/) for their awesome work and tools for the NLP community
- [Luis Nell (Github: originell) and team](https://github.com/originell/jpype/) for maintaining JPype as interface between Python and Java
#### License
- GPLv3+ (check the LICENSE file)