Skip to content

Sydney-Informatics-Hub/clause-segmenter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clause Segmenter

A clause segmenting tool utilising Python's SpaCy

Demo

The following link requires a valid Australian Access Federation login

Binder

Installation

python3 -m pip install clause-segmenter

Documentation

Documentation can be found here

Usage

A code snippet example that uses the ClauseSegmenter

from clause_segmenter import ClauseSegmenter

text = "When I want to leave the house, I have to check if it's raining, so I know whether to bring an umbrella."
segmenter = ClauseSegmenter()
clauses_ls = segmenter.get_clauses_as_list(text)
for clause in clauses_ls:
    print(clause)

Output:

When I want to leave the house
I have to check if it's raining
so I know whether to bring an umbrella

Tests

python3 clause_segmenter/tests/tests.py

Contributing

The package for this project is hosted on PyPi: https://pypi.org/project/clause-segmenter/

Dependencies, publishing, and version numbering is handled by Poetry

To publish a new version:

poetry config pypi-token.pypi <TOKEN>
poetry version minor
poetry publish --build

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details