fast-sentence-segment 0.1.9__tar.gz → 1.4.0__tar.gz

fast_sentence_segment-1.4.0/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-1.4.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.1
+Name: fast-sentence-segment
+Version: 1.4.0
+Summary: Fast and Efficient Sentence Segmentation
+Home-page: https://github.com/craigtrim/fast-sentence-segment
+License: MIT
+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 :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+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/)
+[![CI](https://img.shields.io/github/actions/workflow/status/craigtrim/fast-sentence-segment/ci.yml?branch=master&label=CI)](https://github.com/craigtrim/fast-sentence-segment/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Downloads](https://static.pepy.tech/badge/fast-sentence-segment)](https://pepy.tech/project/fast-sentence-segment)
+[![Downloads/Month](https://static.pepy.tech/badge/fast-sentence-segment/month)](https://pepy.tech/project/fast-sentence-segment)
+
+Fast and efficient sentence segmentation using spaCy with surgical post-processing fixes. Handles complex edge cases like abbreviations (Dr., Mr., etc.), ellipses, quoted text, and multi-paragraph documents.
+
+## Why This Library?
+
+1. **Keep it local**: LLM API calls cost money and send your data to third parties. Run sentence segmentation entirely on your machine.
+2. **spaCy perfected**: spaCy is a great local model, but it makes mistakes. This library fixes most of spaCy's shortcomings.
+
+## Features
+
+- **Paragraph-aware segmentation**: Returns sentences grouped by paragraph
+- **Abbreviation handling**: Correctly handles "Dr.", "Mr.", "etc.", "p.m.", "a.m." without false splits
+- **Ellipsis preservation**: Keeps `...` intact while detecting sentence boundaries
+- **Question/exclamation splitting**: Properly splits on `?` and `!` followed by capital letters
+- **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
+- **CLI tool**: Command-line interface for quick segmentation
+
+## 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 = "Do you like Dr. Who? I prefer Dr. Strange! Mr. T is also cool."
+
+results = segment_text(text, flatten=True)
+```
+
+```json
+[
+  "Do you like Dr. Who?",
+  "I prefer Dr. Strange!",
+  "Mr. T is also cool."
+]
+```
+
+Notice how "Dr. Who?" stays together as a single sentence—the library correctly recognizes that a title followed by a single-word name ending in `?` or `!` is a name reference, not a sentence boundary.
+
+## 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 = """Gandalf spoke softly. "All we have to decide is what to do with the time given us."
+
+Frodo nodded. The weight of the Ring pressed against his chest."""
+
+results = segment_text(text)
+```
+
+```json
+[
+  [
+    "Gandalf spoke softly.",
+    "\"All we have to decide is what to do with the time given us.\"."
+  ],
+  [
+    "Frodo nodded.",
+    "The weight of the Ring pressed against his chest."
+  ]
+]
+```
+
+### Flattened Output
+
+If you don't need paragraph boundaries, use the `flatten` parameter:
+
+```python
+text = "At 9 a.m. the hobbits set out. By 3 p.m. they reached Rivendell. Mr. Frodo was exhausted."
+
+results = segment_text(text, flatten=True)
+```
+
+```json
+[
+  "At 9 a.m. the hobbits set out.",
+  "By 3 p.m. they reached Rivendell.",
+  "Mr. Frodo was exhausted."
+]
+```
+
+### 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.")
+```
+
+### Command Line Interface
+
+```bash
+# Inline text
+segment "Gandalf paused... You shall not pass! The Balrog roared."
+
+# Pipe from stdin
+echo "Have you seen Dr. Who? It's brilliant!" | segment
+
+# Numbered output
+segment -n -f silmarillion.txt
+
+# File-to-file (one sentence per line)
+segment-file --input-file book.txt --output-file sentences.txt
+
+# Unwrap hard-wrapped e-texts (Project Gutenberg, etc.)
+segment-file --input-file book.txt --output-file sentences.txt --unwrap
+```
+
+## API Reference
+
+| Function | Parameters | Returns | Description |
+|----------|------------|---------|-------------|
+| `segment_text()` | `input_text: str`, `flatten: bool = False`, `unwrap: bool = False` | `list` | Main entry point for segmentation |
+| `Segmenter.input_text()` | `input_text: str` | `list[list[str]]` | Cached paragraph-aware segmentation |
+
+### CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `segment [text]` | Segment text from argument, `-f FILE`, or stdin. Use `-n` for numbered output. |
+| `segment-file --input-file IN --output-file OUT [--unwrap]` | Segment a file and write one sentence per line. Use `--unwrap` for hard-wrapped e-texts. |
+
+## 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.9+
+- spaCy 3.8+
+- en_core_web_sm spaCy model
+
+## How It Works
+
+This library uses spaCy for initial sentence segmentation, then applies surgical post-processing fixes for cases where spaCy's default behavior is incorrect:
+
+1. **Pre-processing**: Normalize numbered lists, preserve ellipses with placeholders
+2. **spaCy segmentation**: Use spaCy's sentence boundary detection
+3. **Post-processing**: Split on abbreviation boundaries, handle `?`/`!` + capital patterns
+4. **Denormalization**: Restore placeholders to original text
+
+## 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.4.0/README.md

@@ -0,0 +1,190 @@
+# 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/)
+[![CI](https://img.shields.io/github/actions/workflow/status/craigtrim/fast-sentence-segment/ci.yml?branch=master&label=CI)](https://github.com/craigtrim/fast-sentence-segment/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Downloads](https://static.pepy.tech/badge/fast-sentence-segment)](https://pepy.tech/project/fast-sentence-segment)
+[![Downloads/Month](https://static.pepy.tech/badge/fast-sentence-segment/month)](https://pepy.tech/project/fast-sentence-segment)
+
+Fast and efficient sentence segmentation using spaCy with surgical post-processing fixes. Handles complex edge cases like abbreviations (Dr., Mr., etc.), ellipses, quoted text, and multi-paragraph documents.
+
+## Why This Library?
+
+1. **Keep it local**: LLM API calls cost money and send your data to third parties. Run sentence segmentation entirely on your machine.
+2. **spaCy perfected**: spaCy is a great local model, but it makes mistakes. This library fixes most of spaCy's shortcomings.
+
+## Features
+
+- **Paragraph-aware segmentation**: Returns sentences grouped by paragraph
+- **Abbreviation handling**: Correctly handles "Dr.", "Mr.", "etc.", "p.m.", "a.m." without false splits
+- **Ellipsis preservation**: Keeps `...` intact while detecting sentence boundaries
+- **Question/exclamation splitting**: Properly splits on `?` and `!` followed by capital letters
+- **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
+- **CLI tool**: Command-line interface for quick segmentation
+
+## 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 = "Do you like Dr. Who? I prefer Dr. Strange! Mr. T is also cool."
+
+results = segment_text(text, flatten=True)
+```
+
+```json
+[
+  "Do you like Dr. Who?",
+  "I prefer Dr. Strange!",
+  "Mr. T is also cool."
+]
+```
+
+Notice how "Dr. Who?" stays together as a single sentence—the library correctly recognizes that a title followed by a single-word name ending in `?` or `!` is a name reference, not a sentence boundary.
+
+## 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 = """Gandalf spoke softly. "All we have to decide is what to do with the time given us."
+
+Frodo nodded. The weight of the Ring pressed against his chest."""
+
+results = segment_text(text)
+```
+
+```json
+[
+  [
+    "Gandalf spoke softly.",
+    "\"All we have to decide is what to do with the time given us.\"."
+  ],
+  [
+    "Frodo nodded.",
+    "The weight of the Ring pressed against his chest."
+  ]
+]
+```
+
+### Flattened Output
+
+If you don't need paragraph boundaries, use the `flatten` parameter:
+
+```python
+text = "At 9 a.m. the hobbits set out. By 3 p.m. they reached Rivendell. Mr. Frodo was exhausted."
+
+results = segment_text(text, flatten=True)
+```
+
+```json
+[
+  "At 9 a.m. the hobbits set out.",
+  "By 3 p.m. they reached Rivendell.",
+  "Mr. Frodo was exhausted."
+]
+```
+
+### 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.")
+```
+
+### Command Line Interface
+
+```bash
+# Inline text
+segment "Gandalf paused... You shall not pass! The Balrog roared."
+
+# Pipe from stdin
+echo "Have you seen Dr. Who? It's brilliant!" | segment
+
+# Numbered output
+segment -n -f silmarillion.txt
+
+# File-to-file (one sentence per line)
+segment-file --input-file book.txt --output-file sentences.txt
+
+# Unwrap hard-wrapped e-texts (Project Gutenberg, etc.)
+segment-file --input-file book.txt --output-file sentences.txt --unwrap
+```
+
+## API Reference
+
+| Function | Parameters | Returns | Description |
+|----------|------------|---------|-------------|
+| `segment_text()` | `input_text: str`, `flatten: bool = False`, `unwrap: bool = False` | `list` | Main entry point for segmentation |
+| `Segmenter.input_text()` | `input_text: str` | `list[list[str]]` | Cached paragraph-aware segmentation |
+
+### CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `segment [text]` | Segment text from argument, `-f FILE`, or stdin. Use `-n` for numbered output. |
+| `segment-file --input-file IN --output-file OUT [--unwrap]` | Segment a file and write one sentence per line. Use `--unwrap` for hard-wrapped e-texts. |
+
+## 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.9+
+- spaCy 3.8+
+- en_core_web_sm spaCy model
+
+## How It Works
+
+This library uses spaCy for initial sentence segmentation, then applies surgical post-processing fixes for cases where spaCy's default behavior is incorrect:
+
+1. **Pre-processing**: Normalize numbered lists, preserve ellipses with placeholders
+2. **spaCy segmentation**: Use spaCy's sentence boundary detection
+3. **Post-processing**: Split on abbreviation boundaries, handle `?`/`!` + capital patterns
+4. **Denormalization**: Restore placeholders to original text
+
+## 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.4.0/fast_sentence_segment/__init__.py

@@ -0,0 +1,51 @@
+from .bp import *
+from .svc import *
+from .dmo import *
+
+from .bp.segmenter import Segmenter
+from .dmo.unwrap_hard_wrapped_text import unwrap_hard_wrapped_text
+from .dmo.normalize_quotes import normalize_quotes
+
+segment = Segmenter().input_text
+
+
+def segment_text(
+    input_text: str,
+    flatten: bool = False,
+    unwrap: bool = False,
+    normalize: bool = True,
+) -> list:
+    """Segment text into sentences.
+
+    Args:
+        input_text: The text to segment.
+        flatten: If True, return a flat list of sentences instead of
+            nested paragraphs.
+        unwrap: If True, unwrap hard-wrapped lines (e.g., Project
+            Gutenberg e-texts) before segmenting.
+        normalize: If True (default), normalize unicode quote variants
+            to ASCII equivalents before segmenting. Ensures consistent
+            quote characters for downstream processing.
+
+    Returns:
+        List of sentences (if flatten=True) or list of paragraph
+        groups, each containing a list of sentences.
+
+    Related GitHub Issue:
+        #6 - Review findings from Issue #5
+        https://github.com/craigtrim/fast-sentence-segment/issues/6
+    """
+    if unwrap:
+        input_text = unwrap_hard_wrapped_text(input_text)
+
+    if normalize:
+        input_text = normalize_quotes(input_text)
+
+    results = segment(input_text)
+
+    if flatten:
+        flat = []
+        [[flat.append(y) for y in x] for x in results]
+        return flat
+
+    return results

{fast-sentence-segment-0.1.9 → fast_sentence_segment-1.4.0}/fast_sentence_segment/bp/__init__.py

@@ -1 +1 @@
-from .segmenter import Segmenter
+from .segmenter import Segmenter

{fast-sentence-segment-0.1.9 → fast_sentence_segment-1.4.0}/fast_sentence_segment/bp/segmenter.py

@@ -1,68 +1,65 @@
-#!/usr/bin/env python
-# -*- coding: UTF-8 -*-
-""" Orchestrate Sentence Segmentation """
-
-
-from functools import lru_cache
-
-from baseblock import Enforcer
-from baseblock import Stopwatch
-from baseblock import BaseObject
-
-from fast_sentence_segment.svc import PerformParagraphSegmentation
-from fast_sentence_segment.svc import PerformSentenceSegmentation
-
-
-class Segmenter(BaseObject):
-    """ Orchestrate Sentence Segmentation """
-
-    def __init__(self):
-        """ Change Log
-
-        Created:
-            30-Sept-2021
-        """
-        BaseObject.__init__(self, __name__)
-        self._segment_paragraphs = PerformParagraphSegmentation().process
-        self._segment_sentences = PerformSentenceSegmentation().process
-
-    def _input_text(self,
-                    input_text: str) -> list:
-        paragraphs = []
-
-        for paragraph in self._segment_paragraphs(input_text):
-            paragraphs.append(self._segment_sentences(paragraph))
-
-        return paragraphs
-
-    @lru_cache(maxsize=1024, typed=True)
-    def input_text(self,
-                   input_text: str) -> list:
-        """Segment Input Text into Paragraphs and Sentences
-
-        Args:
-            input_text (str): An input string of any length or type
-
-        Raises:
-            ValueError: input must be a string
-
-        Returns:
-            list:   returns a list of lists.
-                    Each outer list is a paragraph.
-                    Each inner list contains 1..* sentences
-        """
-
-        if self.isEnabledForDebug:
-            Enforcer.is_str(input_text)
-
-        sw = Stopwatch()
-
-        paragraphs = self._input_text(input_text)
-
-        if self.isEnabledForInfo:
-            self.logger.info('\n'.join([
-                "Segmentation of Input Text Complete",
-                f"\tTotal Paragraphs: {len(paragraphs)}",
-                f"\tTotal Time: {str(sw)}"]))
-
-        return paragraphs
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+""" Orchestrate Sentence Segmentation """
+
+
+from functools import lru_cache
+
+from fast_sentence_segment.core import BaseObject, Stopwatch
+from fast_sentence_segment.svc import PerformParagraphSegmentation
+from fast_sentence_segment.svc import PerformSentenceSegmentation
+
+
+class Segmenter(BaseObject):
+    """ Orchestrate Sentence Segmentation """
+
+    def __init__(self):
+        """ Change Log
+
+        Created:
+            30-Sept-2021
+        """
+        BaseObject.__init__(self, __name__)
+        self._segment_paragraphs = PerformParagraphSegmentation().process
+        self._segment_sentences = PerformSentenceSegmentation().process
+
+    def _input_text(self,
+                    input_text: str) -> list:
+        paragraphs = []
+
+        for paragraph in self._segment_paragraphs(input_text):
+            paragraphs.append(self._segment_sentences(paragraph))
+
+        return paragraphs
+
+    @lru_cache(maxsize=1024, typed=True)
+    def input_text(self,
+                   input_text: str) -> list:
+        """Segment Input Text into Paragraphs and Sentences
+
+        Args:
+            input_text (str): An input string of any length or type
+
+        Raises:
+            ValueError: input must be a string
+
+        Returns:
+            list:   returns a list of lists.
+                    Each outer list is a paragraph.
+                    Each inner list contains 1..* sentences
+        """
+
+        if self.isEnabledForDebug and not isinstance(input_text, str):
+            raise ValueError(f"Expected str, got {type(input_text)}")
+
+        sw = Stopwatch()
+
+        paragraphs = self._input_text(input_text)
+
+        if self.isEnabledForInfo:
+            self.logger.info('\n'.join([
+                "Segmentation of Input Text Complete",
+                f"\tTotal Paragraphs: {len(paragraphs)}",
+                f"\tTotal Time: {str(sw)}"]))
+
+        return paragraphs