fast-sentence-segment 0.1.9__py3-none-any.whl → 1.1.8__py3-none-any.whl

fast_sentence_segment-1.1.8.dist-info/METADATA

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: fast-sentence-segment
+Version: 1.1.8
+Summary: Fast and Efficient Sentence Segmentation
+License: MIT
+License-File: LICENSE
+Keywords: nlp,text,preprocess,segment
+Author: Craig Trim
+Author-email: craigtrim@gmail.com
+Maintainer: Craig Trim
+Maintainer-email: craigtrim@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: spacy (>=3.8.0,<4.0.0)
+Project-URL: Bug Tracker, https://github.com/craigtrim/fast-sentence-segment/issues
+Project-URL: Repository, https://github.com/craigtrim/fast-sentence-segment
+Description-Content-Type: text/markdown
+
+# Fast Sentence Segmentation
+
+[![PyPI version](https://img.shields.io/pypi/v/fast-sentence-segment.svg)](https://pypi.org/project/fast-sentence-segment/)
+[![Python versions](https://img.shields.io/pypi/pyversions/fast-sentence-segment.svg)](https://pypi.org/project/fast-sentence-segment/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![spaCy](https://img.shields.io/badge/spaCy-3.5-blue.svg)](https://spacy.io/)
+
+Fast and efficient sentence segmentation using spaCy. Handles complex edge cases like abbreviations (Dr., Mr., etc.), quoted text, and multi-paragraph documents.
+
+## Features
+
+- **Paragraph-aware segmentation**: Returns sentences grouped by paragraph
+- **Abbreviation handling**: Correctly handles "Dr.", "Mr.", "etc." without false splits
+- **Cached processing**: LRU cache for repeated text processing
+- **Flexible output**: Nested lists (by paragraph) or flattened list of sentences
+- **Bullet point & numbered list normalization**: Cleans common list formats
+
+## Installation
+
+```bash
+pip install fast-sentence-segment
+```
+
+After installation, download the spaCy model:
+
+```bash
+python -m spacy download en_core_web_sm
+```
+
+## Quick Start
+
+```python
+from fast_sentence_segment import segment_text
+
+text = "Here is a Dr. who says something. And then again, what else? I don't know. Do you?"
+
+results = segment_text(text)
+# Returns: [['Here is a Dr. who says something.', 'And then again, what else?', "I don't know.", 'Do you?']]
+```
+
+## Usage
+
+### Basic Segmentation
+
+The `segment_text` function returns a list of lists, where each inner list represents a paragraph containing its sentences:
+
+```python
+from fast_sentence_segment import segment_text
+
+text = """First paragraph here. It has two sentences.
+
+Second paragraph starts here. This one also has multiple sentences. And a third."""
+
+results = segment_text(text)
+# Returns:
+# [
+#     ['First paragraph here.', 'It has two sentences.'],
+#     ['Second paragraph starts here.', 'This one also has multiple sentences.', 'And a third.']
+# ]
+```
+
+### Flattened Output
+
+If you don't need paragraph boundaries, use the `flatten` parameter:
+
+```python
+results = segment_text(text, flatten=True)
+# Returns: ['First paragraph here.', 'It has two sentences.', 'Second paragraph starts here.', ...]
+```
+
+### Direct Segmenter Access
+
+For more control, use the `Segmenter` class directly:
+
+```python
+from fast_sentence_segment import Segmenter
+
+segmenter = Segmenter()
+results = segmenter.input_text("Your text here.")
+```
+
+## API Reference
+
+| Function | Parameters | Returns | Description |
+|----------|------------|---------|-------------|
+| `segment_text()` | `input_text: str`, `flatten: bool = False` | `list` | Main entry point for segmentation |
+| `Segmenter.input_text()` | `input_text: str` | `list[list[str]]` | Cached paragraph-aware segmentation |
+
+## Why Nested Lists?
+
+The segmentation process preserves document structure by segmenting into both paragraphs and sentences. Each outer list represents a paragraph, and each inner list contains that paragraph's sentences. This is useful for:
+
+- Document structure analysis
+- Paragraph-level processing
+- Maintaining original text organization
+
+Use `flatten=True` when you only need sentences without paragraph context.
+
+## Requirements
+
+- Python 3.8.5+
+- spaCy 3.5.3
+- en_core_web_sm spaCy model
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Run tests (`make test`)
+4. Commit your changes
+5. Push to the branch
+6. Open a Pull Request
+

fast_sentence_segment-1.1.8.dist-info/RECORD

@@ -0,0 +1,20 @@
+fast_sentence_segment/__init__.py,sha256=HTONyC0JLVWTAHyvJO6rMINmxymbfMpARtGeRw5iIsQ,359
+fast_sentence_segment/bp/__init__.py,sha256=j2-WfQ9WwVuXeGSjvV6XLVwEdvau8sdAQe4Pa4DrYi8,33
+fast_sentence_segment/bp/segmenter.py,sha256=UW6DguPgA56h-pPYRsfJhjIzBe40j6NdjkwYxamASyA,1928
+fast_sentence_segment/core/__init__.py,sha256=uoBersYyVStJ5a8zJpQz1GDGaloEdAv2jGHw1292hRM,108
+fast_sentence_segment/core/base_object.py,sha256=AYr7yzusIwawjbKdvcv4yTEnhmx6M583kDZzhzPOmq4,635
+fast_sentence_segment/core/stopwatch.py,sha256=hE6hMz2q6rduaKi58KZmiAL-lRtyh_wWCANhl4KLkRQ,879
+fast_sentence_segment/dmo/__init__.py,sha256=Tz1ICwhQLimQ3KoZM4f5HQFFgYamnMAn4opcyIB7Chk,328
+fast_sentence_segment/dmo/bullet_point_cleaner.py,sha256=WOZQRWXiiyRi8rOuEIw36EmkaXmATHL9_Dxb2rderw4,1606
+fast_sentence_segment/dmo/delimiters_to_periods.py,sha256=cshN3TU2YzCHWVGGDnd_FOQJluyRExpYPrpZ_BQQeko,857
+fast_sentence_segment/dmo/newlines_to_periods.py,sha256=PUrXreqZWiITINfoJL5xRRlXJH6noH0cdXtW1EqAh8I,1517
+fast_sentence_segment/dmo/numbered_list_normalizer.py,sha256=q0cLiTUt6ITX_cCwCRrIR7A3o92WOKVWpFWs8P5Gu5M,1549
+fast_sentence_segment/dmo/post_process_sentences.py,sha256=5jxG3TmFjxIExMPLhnCB5JT1lXQvFU9r4qQGoATGrWk,916
+fast_sentence_segment/dmo/spacy_doc_segmenter.py,sha256=0icAkSQwAUQo3VYqQ2PUjW6-MOU5RNCGPX3-fB5YfCc,2554
+fast_sentence_segment/svc/__init__.py,sha256=9B12mXxBnlalH4OAm1AMLwUMa-RLi2ilv7qhqv26q7g,144
+fast_sentence_segment/svc/perform_paragraph_segmentation.py,sha256=zLKw9rSzb0NNfx4MyEeoGrHwhxTtH5oDrYcAL2LMVHY,1378
+fast_sentence_segment/svc/perform_sentence_segmentation.py,sha256=ZT231A5CJ5v9tGpYbny_eq8SzgEdEwVTCVu9OV_UO9g,3839
+fast_sentence_segment-1.1.8.dist-info/METADATA,sha256=mCHUoRPcbOcSlffv6-da66W2KZU6P5OUBQFnGFgJhQU,4817
+fast_sentence_segment-1.1.8.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+fast_sentence_segment-1.1.8.dist-info/licenses/LICENSE,sha256=vou5JCLAT5nHcsUv-AkjUYAihYfN9mwPDXxV2DHyHBo,1067
+fast_sentence_segment-1.1.8.dist-info/RECORD,,

{fast_sentence_segment-0.1.9.dist-info → fast_sentence_segment-1.1.8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry 1.0.7
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any

fast_sentence_segment-1.1.8.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Craig Trim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fast_sentence_segment-0.1.9.dist-info/METADATA

@@ -1,54 +0,0 @@
-Metadata-Version: 2.1
-Name: fast-sentence-segment
-Version: 0.1.9
-Summary: Fast and Efficient Sentence Segmentation
-Home-page: https://github.com/craigtrim/fast-sentence-segment
-License: None
-Keywords: nlp,text,preprocess,segment
-Author: Craig Trim
-Author-email: craigtrim@gmail.com
-Maintainer: Craig Trim
-Maintainer-email: craigtrim@gmail.com
-Requires-Python: >=3.8.5,<4.0.0
-Classifier: Development Status :: 4 - Beta
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: baseblock
-Requires-Dist: spacy (==3.5.0)
-Project-URL: Bug Tracker, https://github.com/craigtrim/fast-sentence-segment/issues
-Project-URL: Repository, https://github.com/craigtrim/fast-sentence-segment
-Description-Content-Type: text/markdown
-
-# Fast Sentence Segmentation (fast-sentence-segment)
-Fast and Efficient Sentence Segmentation
-
-Usage
-```python
-from fast_sentence_segment import segment_text
-
-results = segment_text(
-    'here is a dr. who says something.  and then again, what else?  i dont know.  Do you?')
-
-assert results == [
-    [
-        'here is a dr. who says something.',
-        'and then again, what else?',
-        'i dont know.',
-        'Do you?'
-    ]
-]
-```
-
-Why use a double-scripted list?
-
-The segementation process will segment into paragraphs and sentences.  A paragraph is composed of 1..* sentences, hence each list of lists is equivalent to a paragraph.
-
-This usage
-```python
-results = segment_text(input_text, flatten=True)
-```
-Will return a list of strings, regardless of paragraph delimitation.
-

fast_sentence_segment-0.1.9.dist-info/RECORD

@@ -1,16 +0,0 @@
-fast_sentence_segment/__init__.py,sha256=otzCTZrivtWR5GbQ_-eCfYgwKhyNCL2XGM17YNI1YWo,377
-fast_sentence_segment/bp/__init__.py,sha256=M0y9HPbk6hrB1yiG7Fd8G8UGoO05IRZzOgInMBe883g,34
-fast_sentence_segment/bp/segmenter.py,sha256=h0xnNUkeoz_AyDXCocUozCx8X40FmWgm8xJsN3DoCYg,1966
-fast_sentence_segment/dmo/__init__.py,sha256=sVkdjzjCV_8BAMZBiuuAYs_1MUSpdo7YxC2ThRnBhPI,334
-fast_sentence_segment/dmo/bullet_point_cleaner.py,sha256=K6hsLttTq3xxLJnQijxYQUAGISoDuUKiGQM7oiQgEBU,1644
-fast_sentence_segment/dmo/delimiters_to_periods.py,sha256=CJrxKnADZhMnXlOXLSuLupq9aGvp_ir4LyKTQE4SByU,877
-fast_sentence_segment/dmo/newlines_to_periods.py,sha256=EnafiZ1TQvqZXXHNEmvCveuUtolIUc8oaCOFHAb0nnw,1557
-fast_sentence_segment/dmo/numbered_list_normalizer.py,sha256=ljbEyabjjA1IWYD17ryu4_UKaa0WEfpE9LCa-laaplo,1585
-fast_sentence_segment/dmo/post_process_sentences.py,sha256=vyKF89guI_EO_qkY0Uh4JeVbJr_SwEQYfBKAwhiSTKU,947
-fast_sentence_segment/dmo/spacy_doc_segmenter.py,sha256=HAVYyTjzmuC0zcG36rJ48Ueq7tXfTplB-y5vb3p64CE,2638
-fast_sentence_segment/svc/__init__.py,sha256=4nQTjRMoSu1n_2p8o1I7xyhOe8_kGZJ3TghgzVLGAos,146
-fast_sentence_segment/svc/perform_paragraph_segmentation.py,sha256=mYlXvwz0JTbIUSfZeD49fG7nFe5V6eIKOIL9HqQDyII,1403
-fast_sentence_segment/svc/perform_sentence_segmentation.py,sha256=Q6KBt83iQ662L6EgyTsfWBk-aOqcltRt0Y9MhYhqJsI,3943
-fast_sentence_segment-0.1.9.dist-info/WHEEL,sha256=y3eDiaFVSNTPbgzfNn0nYn5tEn1cX6WrdetDlQM4xWw,83
-fast_sentence_segment-0.1.9.dist-info/METADATA,sha256=Uc1zNsXLHGdtfcklI4g0gj0pkLv_0PSOQoXObLuuxjk,1733
-fast_sentence_segment-0.1.9.dist-info/RECORD,,