Build Status

Travis CI Builds

PyPI

Code Quality

Installation

>># Ideally, create a virtual environment before installing any dependencies>> pip install sutime>># Install Java dependencies>> mvn dependency:copy-dependencies -DoutputDirectory=./jars -f$(python3 -c'import importlib; import pathlib; print(pathlib.Path(importlib.util.find_spec("sutime").origin).parent / "pom.xml")')

Supported Languages

>> mvn dependency:copy-dependencies -DoutputDirectory=./jars -f$(python -c'import importlib; import pathlib; print(pathlib.Path(importlib.util.find_spec("sutime").origin).parent / "pom.xml")') -P<language>

Example

importjsonfromsutimeimportSUTimeif__name__=='__main__':test_case='I need a desk for tomorrow from 2pm to 3pm'sutime=SUTime(mark_time_ranges=True,include_range=True)print(json.dumps(sutime.parse(test_case),sort_keys=True,indent=4))

[    {"end":26,"start":18,"text":"tomorrow","timex-value":"2020-11-03","type":"DATE","value":"2020-11-03"    },    {"end":42,"start":27,"text":"from 2pm to 3pm","type":"DURATION","value": {"begin":"T14:00","end":"T15:00"        }    }]

Functions

SUTime(jars:Optional[str]=None,jvm_started:Optional[bool]=False,mark_time_ranges:Optional[bool]=False,include_range:Optional[bool]=False,jvm_flags:Optional[List[str]]=None,language:Optional[str]='english',):"""    Args:        jars (Optional[str]): Path to previously downloaded SUTime Java            dependencies. Defaults to False.        jvm_started (Optional[bool]): Flag to indicate that JVM has been            already started (with all Java dependencies loaded). Defaults            to False.        mark_time_ranges (Optional[bool]): SUTime flag for            sutime.markTimeRanges. Defaults to False.            "Whether or not to recognize time ranges such as 'July to            August'"        include_range (Optional[bool]): SUTime flag for            sutime.includeRange. Defaults to False.            "Whether or not to add range info to the TIMEX3 object"        jvm_flags (Optional[List[str]]): List of flags passed to JVM. For            example, this may be used to specify the maximum heap size            using '-Xmx'. Has no effect if `jvm_started` is set to True.            Defaults to None.        language (Optional[str]): Selected language. Currently supported            are: english (/en), british, spanish (/es). Defaults to            `english`.    """sutime.parse(input_str:str,reference_date:Optional[str]='')->List[Dict]:"""Parse datetime information out of string input.    It invokes the SUTimeWrapper.annotate() function in Java.    Args:        input_str (str): The input as string that has to be parsed.        reference_date (Optional[str]): Optional reference data for SUTime.            Defaults to `''`.    Returns:        A list of dicts with the result from the `SUTimeWrapper.annotate()`        call.    Raises:        RuntimeError: An error occurs when CoreNLP is not loaded.    """

Credit

Contributions

License