Metadata-Version: 2.4
Name: pysegmenters-syntok
Version: 1.6.39
Summary: syntok segmenter
Project-URL: Homepage, https://github.com/oterrier/pysegmenters_syntok/
Author-email: Olivier Terrier <olivier.terrier@kairntech.com>
License-Expression: MIT
License-File: AUTHORS.md
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Requires-Dist: pymultirole-plugins<0.7.0,>=0.6.0
Requires-Dist: syntok
Provides-Extra: dev
Requires-Dist: bump2version; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Provides-Extra: docs
Requires-Dist: lxml-html-clean; extra == 'docs'
Requires-Dist: m2r2; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Requires-Dist: sphinxcontrib-apidoc; extra == 'docs'
Provides-Extra: sbom
Requires-Dist: cyclonedx-bom; extra == 'sbom'
Requires-Dist: pip-audit; extra == 'sbom'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: ruff; extra == 'test'
Description-Content-Type: text/markdown

# pysegmenters_syntok

[![license](https://img.shields.io/github/license/oterrier/pysegmenters_syntok)](https://github.com/oterrier/pysegmenters_syntok/blob/master/LICENSE)
[![tests](https://github.com/oterrier/pysegmenters_syntok/workflows/tests/badge.svg)](https://github.com/oterrier/pysegmenters_syntok/actions?query=workflow%3Atests)
[![codecov](https://img.shields.io/codecov/c/github/oterrier/pysegmenters_syntok)](https://codecov.io/gh/oterrier/pysegmenters_syntok)
[![docs](https://img.shields.io/readthedocs/pysegmenters_syntok)](https://pysegmenters_syntok.readthedocs.io)
[![version](https://img.shields.io/pypi/v/pysegmenters_syntok)](https://pypi.org/project/pysegmenters_syntok/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysegmenters_syntok)](https://pypi.org/project/pysegmenters_syntok/)

Rule based segmenter based on syntok

## Installation

You can simply `pip install pysegmenters_syntok`.

## Developing

### Pre-requesites

You will need to install `uv` (for building and managing the package):

```
pip install uv
```

Clone the repository:

```
git clone https://github.com/oterrier/pysegmenters_syntok
```

### Running the test suite

You can run the full test suite against Python 3.12 with:

```
uv run pytest
```

### Linting

```
uv run ruff check .
uv run ruff format --check .
```

### Building the documentation

You can build the HTML documentation with:

```
uv run --extra docs sphinx-build docs docs/_build
```

The built documentation is available at `docs/_build/index.html`.

## SBOM & vulnerability check

Install the SBOM dependencies:

```
uv sync --extra sbom
```

Generate a CycloneDX SBOM from the current environment:

```
uv run cyclonedx-py environment -o sbom.cdx.json --output-format json
```

Audit dependencies for known vulnerabilities:

```
uv run pip-audit --format json --output audit-report.json
```

To fail on any known vulnerability (useful in CI):

```
uv run pip-audit --strict
```
