Metadata-Version: 2.4
Name: arabseg
Version: 0.19.1
Summary: Deterministic, tashkeel-preserving Arabic morphological segmentation
Author: Eman Khater
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Keywords: arabic,natural-language-processing,morphology,segmentation,tashkeel,diacritics,modern-standard-arabic
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
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: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML<7.0,>=6.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-cov>=5.0; extra == "dev"
Requires-Dist: tomli>=2.0; python_version < "3.11" and extra == "dev"
Requires-Dist: ruff>=0.5; extra == "dev"
Requires-Dist: twine>=5.1; extra == "dev"
Dynamic: license-file

# ArabSeg

**Deterministic, tashkeel-preserving morphological segmentation for fully vocalized Modern Standard Arabic.**

ArabSeg is a Python library and command-line application for transparent, resource-driven analysis of fully vocalized Modern Standard Arabic (MSA) words. It preserves the exact Unicode input, applies explicit lexical and morphotactic rules, retains every supported analysis, and produces deterministic results suitable for research, testing, and reproducible NLP workflows.

> **Development status:** ArabSeg `0.19.0` is an alpha release. Public interfaces and linguistic resources may still change before `1.0.0`.

## Key Features

- Exact preservation of Arabic characters and tashkeel.
- Inventory-backed Unicode and repertoire validation.
- Grapheme parsing and orthographic validation.
- Explicit lexicon and morphotactic YAML resources.
- Proclitic, stem, and enclitic segmentation.
- Feature unification across candidate segments.
- Deterministic ambiguity grouping without hidden ranking.
- Structured Python results and deterministic JSON output.
- Command-line tools for analysis, validation, resource checking, and diagnostics.
- Optional deterministic caching and performance instrumentation.

## Scope

The current release targets **one fully vocalized MSA word at a time**.

ArabSeg does not currently provide:

- automatic diacritization;
- unvocalized or partially vocalized analysis;
- dialectal Arabic processing;
- sentence tokenization or contextual disambiguation;
- probabilistic ranking or neural prediction.

See [Limitations](docs/11_Limitations.md) for the complete scope statement.

## Requirements

- Python 3.10 or later
- PyYAML 6.x

## Installation

### Install from the repository

```bash
git clone <repository-url>
cd ArabSeg
python -m venv .venv
```

Activate the environment.

**Windows PowerShell**

```powershell
.venv\Scripts\Activate.ps1
```

**Linux or macOS**

```bash
source .venv/bin/activate
```

Install ArabSeg:

```bash
python -m pip install --upgrade pip
python -m pip install -e .
```

For development tools:

```bash
python -m pip install -e ".[dev]"
```

Confirm the installation:

```bash
arabseg version
python -c "import arabseg; print(arabseg.__version__)"
```

See [Installation](docs/02_Installation.md) for platform-specific details.

## Quick Validation Example

The public Unicode validation layer can be used without constructing the complete morphological pipeline:

```python
from arabseg import UnicodeValidator

result = UnicodeValidator().validate("كِتَابُ")

print(result.valid)
print(result.errors)
```

This validates supported Unicode and repertoire constraints. Structural orthography and full-vocalization policy decisions are separate validation stages.

## Morphological Analysis

A complete analyzer is constructed explicitly from:

1. a lexicon resource;
2. a morphotactics resource;
3. their expected versions;
4. an approved vocalization policy.

The repository includes a compact test resource set under `tests/golden/resources/`.

```python
from pathlib import Path

from arabseg.configuration import (
    AnalyzerConfiguration,
    build_default_analyzer,
)
from arabseg.segmenter.engine import (
    VocalizationDecision,
)


class ExampleVocalizationPolicy:
    """Minimal example policy for the documented test resource set."""

    APPROVED = {
        "كِتَابُ",
        "وَكِتَابُ",
        "وَكِتَابُهُ",
    }

    def evaluate(self, source: str) -> VocalizationDecision:
        if source in self.APPROVED:
            return VocalizationDecision.VALID
        return VocalizationDecision.INVALID


configuration = AnalyzerConfiguration(
    lexicon_path=Path("tests/golden/resources/lexicon.yaml"),
    morphotactics_path=Path(
        "tests/golden/resources/morphotactics.yaml"
    ),
    lexicon_version="1.0",
    grammar_version="1.0",
)

analyzer = build_default_analyzer(
    configuration,
    vocalization_policy=ExampleVocalizationPolicy(),
)

bundle = analyzer.analyze("وَكِتَابُهُ")

for analysis in bundle.analyses:
    print([segment.surface for segment in analysis.segments])
    print(dict(analysis.unified_features))
    print(analysis.reconstruct() == bundle.source)
```

Expected segmentation:

```text
['وَ', 'كِتَابُ', 'هُ']
```

The example policy is intentionally limited to the test fixtures. Production or research use requires a policy based on an approved linguistic specification.

## Command-Line Interface

Display help and version information:

```bash
arabseg --help
arabseg version
```

Validate input structurally:

```bash
arabseg validate "كِتَابُ" --profile structural
```

Analyze a word using explicit resources and an importable policy:

```bash
arabseg analyze "وَكِتَابُهُ" \
  --lexicon tests/golden/resources/lexicon.yaml \
  --morphotactics tests/golden/resources/morphotactics.yaml \
  --lexicon-version 1.0 \
  --grammar-version 1.0 \
  --policy my_project.policies:ApprovedVocalizationPolicy \
  --json
```

Validate resource integrity:

```bash
arabseg resources \
  --lexicon tests/golden/resources/lexicon.yaml \
  --morphotactics tests/golden/resources/morphotactics.yaml \
  --lexicon-version 1.0 \
  --grammar-version 1.0 \
  --validate
```

Check configuration, resources, policy loading, and analyzer construction:

```bash
arabseg doctor \
  --lexicon tests/golden/resources/lexicon.yaml \
  --morphotactics tests/golden/resources/morphotactics.yaml \
  --lexicon-version 1.0 \
  --grammar-version 1.0 \
  --policy my_project.policies:ApprovedVocalizationPolicy
```

See the [CLI Guide](docs/05_CLI_Guide.md) for command behavior and exit codes.

## Processing Pipeline

```text
Input word
    ↓
Unicode and repertoire validation
    ↓
Grapheme parsing
    ↓
Orthographic and vocalization validation
    ↓
Deterministic boundary generation
    ↓
Lexical candidate lookup
    ↓
Morphotactic compatibility
    ↓
Feature unification
    ↓
Ambiguity grouping
    ↓
Immutable analysis bundle
```

No stage silently rewrites the source. Every accepted analysis must reconstruct the original input exactly.

## Documentation

| Document | Purpose |
|---|---|
| [Project Overview](docs/01_Project_Overview.md) | Goals, scope, and design principles |
| [Installation](docs/02_Installation.md) | Environment and installation instructions |
| [Quick Start](docs/03_Quick_Start.md) | First-use workflow |
| [Python API](docs/04_Python_API.md) | Public classes, models, and functions |
| [CLI Guide](docs/05_CLI_Guide.md) | Commands, arguments, JSON, and exit codes |
| [Output Interpretation](docs/06_Output_Interpretation.md) | Analyses, failures, ambiguity, and reconstruction |
| [Architecture](docs/07_Architecture.md) | Components and processing flow |
| [Resource Format](docs/08_Resource_Format.md) | Lexicon and morphotactics YAML schemas |
| [Extending ArabSeg](docs/09_Extending_ArabSeg.md) | Policies and replaceable pipeline components |
| [FAQ](docs/10_FAQ.md) | Common usage questions |
| [Limitations](docs/11_Limitations.md) | Current boundaries and non-goals |
| [Developer Guide](docs/12_Developer_Guide.md) | Testing, quality checks, packaging, and releases |

The repository also retains milestone-level implementation notes and formal specification documents under `docs/`.

## Repository Structure

```text
ArabSeg/
├── src/arabseg/          # Package implementation
├── tests/                # Unit, integration, regression, and golden tests
├── docs/                 # User, architecture, and specification documents
├── knowledge/            # Earlier knowledge-resource material
├── pyproject.toml        # Packaging and tool configuration
├── CHANGELOG.md          # Release history
├── MANIFEST.in           # Source-distribution inclusions
└── LICENSE               # License file
```

## Development

Install development dependencies:

```bash
python -m pip install -e ".[dev]"
```

Run the quality checks:

```bash
ruff check src tests
ruff format --check src tests
mypy src
pytest
```

Build distributions:

```bash
python -m build
python -m twine check dist/*
```

See the [Developer Guide](docs/12_Developer_Guide.md) before preparing a release.

## Project Status

ArabSeg is under active development. Version `0.19.0` includes the complete deterministic pipeline, explicit resource loading and validation, the command-line interface, caching support, packaging configuration, and end-to-end golden regression tests.

The project remains alpha because the public API, linguistic coverage, and full-vocalization profile are still being refined before `1.0.0`.

## Citation

A formal citation will be added when an associated publication or archived software release is available.

Until then, cite the repository name, version, author, and access date according to the citation style required by your work.

## License

ArabSeg is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
