zyntalic 0.3.0__tar.gz

zyntalic-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 zolton
+
+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.

zyntalic-0.3.0/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: zyntalic
+Version: 0.3.0
+Summary: Deterministic synthetic-language toolkit (Zyntalic) with anchor priors and S-O-V-C surface order
+Author: zolton
+License: MIT
+Project-URL: Homepage, https://github.com/kugguk2022/Zyntalic_idiom
+Project-URL: Documentation, https://github.com/kugguk2022/Zyntalic_idiom/tree/main/wiki
+Project-URL: Issues, https://github.com/kugguk2022/Zyntalic_idiom/issues
+Project-URL: Source, https://github.com/kugguk2022/Zyntalic_idiom
+Keywords: synthetic-language,conlang,translation,schelling-points,deterministic
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Artistic Software
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: hypothesis>=6.100.0; extra == "dev"
+Requires-Dist: coverage>=7.5.0; extra == "dev"
+Requires-Dist: httpx>=0.27.0; extra == "dev"
+Provides-Extra: web
+Requires-Dist: fastapi>=0.110.0; extra == "web"
+Requires-Dist: uvicorn[standard]>=0.29.0; extra == "web"
+Requires-Dist: pydantic>=2.0.0; extra == "web"
+Requires-Dist: python-multipart>=0.0.9; extra == "web"
+Provides-Extra: embeddings
+Requires-Dist: sentence-transformers>=2.6.0; extra == "embeddings"
+Provides-Extra: embeddings-bge
+Requires-Dist: sentence-transformers>=2.6.0; extra == "embeddings-bge"
+Provides-Extra: pdf
+Requires-Dist: pypdf>=5.0.0; extra == "pdf"
+Provides-Extra: desktop
+Requires-Dist: pywebview>=4.4.1; extra == "desktop"
+Provides-Extra: data
+Requires-Dist: requests>=2.31.0; extra == "data"
+Requires-Dist: beautifulsoup4>=4.12.0; extra == "data"
+Requires-Dist: tqdm>=4.66.0; extra == "data"
+Provides-Extra: nlp
+Requires-Dist: spacy>=3.7.0; extra == "nlp"
+Requires-Dist: typer>=0.9.0; extra == "nlp"
+Requires-Dist: click>=8.1.7; extra == "nlp"
+Dynamic: license-file
+
+# Zyntalic
+
+<p align="center">
+  <img src="zyntalic-flow/public/favicon.svg" alt="Zyntalic logo" width="360">
+</p>
+
+<p align="center">
+  <strong>A deterministic synthetic-language engine for reproducible creative text.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/kugguk2022/Zyntalic_idiom/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/kugguk2022/Zyntalic_idiom/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+  <img alt="Python 3.10+" src="https://img.shields.io/badge/python-3.10%2B-3776AB.svg">
+  <img alt="Status: experimental" src="https://img.shields.io/badge/status-experimental-orange.svg">
+</p>
+
+Zyntalic maps source text to a stable constructed-language surface using seeded word generation, literary anchor priors, mixed Hangul/Latin forms, and Subject–Object–Verb–Context (S-O-V-C) ordering. Each non-reverse result ends with a machine-readable `⟦ctx: ...⟧` trace.
+
+The baseline runs locally with NumPy. Embeddings, NLP, PDF extraction, the web API, and desktop integration are optional.
+
+> [!IMPORTANT]
+> Zyntalic is experimental. Output stability is a design goal within a fixed code and resource version, not a permanent compatibility guarantee. Record the package version and generation options with production assets.
+
+## Why Zyntalic?
+
+- **Repeatable:** stable seeded generation supports revision and regeneration.
+- **Inspectible:** anchors, frames, sigils, scope, and warnings are available as structured metadata.
+- **Rule-first:** the core works without a hosted model or heavyweight NLP stack.
+- **Controllable:** anchor mode, frames, register, dialect, evidentiality, engine, and mirror rate are explicit options.
+- **Integrable:** use the Python API, CLI, authenticated REST API, React interface, or desktop launcher.
+
+Read [the idea](wiki/idea.md), [core concepts](wiki/core-concepts.md), and the honest [current-state inventory](wiki/current-state.md) for the full project context.
+
+## Quick start
+
+### Python and CLI
+
+```bash
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+python -m pip install -e .
+
+zyntalic translate "I see the river at night." --format plain
+```
+
+From Python:
+
+```python
+from zyntalic.translator import translate_sentence
+
+result = translate_sentence("I see the river at night.", engine="core", mirror_rate=0.3)
+print(result["target"])
+print(result["sidecar"])
+```
+
+### Desktop experience
+
+On Windows, run `run_desktop.bat`. On any supported platform with the optional dependencies installed:
+
+```bash
+python -m pip install -e ".[web,pdf,desktop]"
+python -m scripts.run_desktop
+```
+
+The desktop launcher binds to localhost and explicitly enables local unauthenticated mode. Do not use that override on a network-facing deployment.
+
+## REST API
+
+Install and start the authenticated API:
+
+```bash
+python -m pip install -e ".[web,pdf]"
+export ZYNTALIC_API_KEY="$(python -c 'import secrets; print(secrets.token_urlsafe(32))')"
+uvicorn apps.web.app:app --host 127.0.0.1 --port 8000
+```
+
+```bash
+curl --fail-with-body http://127.0.0.1:8000/v1/translate \
+  -H 'Content-Type: application/json' \
+  -H "X-API-Key: $ZYNTALIC_API_KEY" \
+  -d '{"text":"I see the river at night.","engine":"core","mirror_rate":0.3}'
+```
+
+| Endpoint | Purpose | Authentication |
+| --- | --- | --- |
+| `GET /v1/health` | Readiness, limits, version, and cache status | Public |
+| `POST /v1/translate` | Translate one input with request metadata | API key |
+| `POST /v1/translate/batch` | Translate up to 32 ordered inputs | API key |
+| `POST /v1/extract` | Extract UTF-8 text from PDF, TXT, or Markdown | API key |
+| `GET /docs` | Interactive OpenAPI reference | Public |
+
+The in-process rate limiter is suitable for one server process. Multi-worker and distributed deployments should enforce shared limits at a gateway. Configure limits, CORS, cache location, and authentication through the variables documented in [.env.example](.env.example).
+
+## Development
+
+```bash
+python -m pip install -e ".[dev,web,pdf]"
+ruff check .
+pytest
+```
+
+The project has three inherited regression failures tracked in [issue #9](https://github.com/kugguk2022/Zyntalic_idiom/issues/9). CI runs the remainder as a required suite and reports those cases separately; deselection is not their acceptance criterion.
+
+Frontend development:
+
+```bash
+cd zyntalic-flow
+npm ci
+npm run build
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for environment setup, test selection, deterministic-change review, and pull-request expectations.
+
+## Project structure
+
+```text
+apps/                  Application adapters, including the FastAPI service
+data/                  Small fixtures and anchor inputs
+data_generation/       Corpus acquisition and transformation pipeline
+docker/                Container build definition
+evals/                 Evaluation and smoke checks
+lexicon/               Checkout/runtime literary lexicons
+scripts/               Operational, training, and maintenance commands
+tests/                 Primary automated test suite
+wiki/                  Product idea, history, architecture, and roadmap
+zyntalic/              Installable Python engine
+zyntalic_docs/         Generated language-design reference
+zyntalic-flow/         React/Vite frontend
+```
+
+The [repository guide](wiki/repository-guide.md) defines ownership, safe cleanup practices, legacy directories, and generated artifacts.
+
+## Documentation
+
+- [Project wiki](wiki/README.md)
+- [Architecture](wiki/architecture.md)
+- [Language reference](zyntalic_docs/README.md)
+- [Dataset pipeline](DATASET.md)
+- [Embeddings](EMBEDDINGS.md)
+- [Roadmap](wiki/roadmap.md)
+- [Changelog](CHANGELOG.md)
+- [Security policy](SECURITY.md)
+
+## Scope and limitations
+
+Zyntalic is a creative toolkit, not a linguistically complete English parser or a translation system for a naturally spoken language. The default parser intentionally uses stable heuristics. The generated language reference contains design material that should be backed by executable tests before being treated as a compatibility guarantee.
+
+Corpus and fixture contributions must be redistributable and must not contain personal or confidential information. See [CONTRIBUTING.md](CONTRIBUTING.md#data-and-lexicon-contributions).
+
+## License
+
+Released under the [MIT License](LICENSE).

zyntalic-0.3.0/README.md

@@ -0,0 +1,153 @@
+# Zyntalic
+
+<p align="center">
+  <img src="zyntalic-flow/public/favicon.svg" alt="Zyntalic logo" width="360">
+</p>
+
+<p align="center">
+  <strong>A deterministic synthetic-language engine for reproducible creative text.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/kugguk2022/Zyntalic_idiom/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/kugguk2022/Zyntalic_idiom/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+  <img alt="Python 3.10+" src="https://img.shields.io/badge/python-3.10%2B-3776AB.svg">
+  <img alt="Status: experimental" src="https://img.shields.io/badge/status-experimental-orange.svg">
+</p>
+
+Zyntalic maps source text to a stable constructed-language surface using seeded word generation, literary anchor priors, mixed Hangul/Latin forms, and Subject–Object–Verb–Context (S-O-V-C) ordering. Each non-reverse result ends with a machine-readable `⟦ctx: ...⟧` trace.
+
+The baseline runs locally with NumPy. Embeddings, NLP, PDF extraction, the web API, and desktop integration are optional.
+
+> [!IMPORTANT]
+> Zyntalic is experimental. Output stability is a design goal within a fixed code and resource version, not a permanent compatibility guarantee. Record the package version and generation options with production assets.
+
+## Why Zyntalic?
+
+- **Repeatable:** stable seeded generation supports revision and regeneration.
+- **Inspectible:** anchors, frames, sigils, scope, and warnings are available as structured metadata.
+- **Rule-first:** the core works without a hosted model or heavyweight NLP stack.
+- **Controllable:** anchor mode, frames, register, dialect, evidentiality, engine, and mirror rate are explicit options.
+- **Integrable:** use the Python API, CLI, authenticated REST API, React interface, or desktop launcher.
+
+Read [the idea](wiki/idea.md), [core concepts](wiki/core-concepts.md), and the honest [current-state inventory](wiki/current-state.md) for the full project context.
+
+## Quick start
+
+### Python and CLI
+
+```bash
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+python -m pip install -e .
+
+zyntalic translate "I see the river at night." --format plain
+```
+
+From Python:
+
+```python
+from zyntalic.translator import translate_sentence
+
+result = translate_sentence("I see the river at night.", engine="core", mirror_rate=0.3)
+print(result["target"])
+print(result["sidecar"])
+```
+
+### Desktop experience
+
+On Windows, run `run_desktop.bat`. On any supported platform with the optional dependencies installed:
+
+```bash
+python -m pip install -e ".[web,pdf,desktop]"
+python -m scripts.run_desktop
+```
+
+The desktop launcher binds to localhost and explicitly enables local unauthenticated mode. Do not use that override on a network-facing deployment.
+
+## REST API
+
+Install and start the authenticated API:
+
+```bash
+python -m pip install -e ".[web,pdf]"
+export ZYNTALIC_API_KEY="$(python -c 'import secrets; print(secrets.token_urlsafe(32))')"
+uvicorn apps.web.app:app --host 127.0.0.1 --port 8000
+```
+
+```bash
+curl --fail-with-body http://127.0.0.1:8000/v1/translate \
+  -H 'Content-Type: application/json' \
+  -H "X-API-Key: $ZYNTALIC_API_KEY" \
+  -d '{"text":"I see the river at night.","engine":"core","mirror_rate":0.3}'
+```
+
+| Endpoint | Purpose | Authentication |
+| --- | --- | --- |
+| `GET /v1/health` | Readiness, limits, version, and cache status | Public |
+| `POST /v1/translate` | Translate one input with request metadata | API key |
+| `POST /v1/translate/batch` | Translate up to 32 ordered inputs | API key |
+| `POST /v1/extract` | Extract UTF-8 text from PDF, TXT, or Markdown | API key |
+| `GET /docs` | Interactive OpenAPI reference | Public |
+
+The in-process rate limiter is suitable for one server process. Multi-worker and distributed deployments should enforce shared limits at a gateway. Configure limits, CORS, cache location, and authentication through the variables documented in [.env.example](.env.example).
+
+## Development
+
+```bash
+python -m pip install -e ".[dev,web,pdf]"
+ruff check .
+pytest
+```
+
+The project has three inherited regression failures tracked in [issue #9](https://github.com/kugguk2022/Zyntalic_idiom/issues/9). CI runs the remainder as a required suite and reports those cases separately; deselection is not their acceptance criterion.
+
+Frontend development:
+
+```bash
+cd zyntalic-flow
+npm ci
+npm run build
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for environment setup, test selection, deterministic-change review, and pull-request expectations.
+
+## Project structure
+
+```text
+apps/                  Application adapters, including the FastAPI service
+data/                  Small fixtures and anchor inputs
+data_generation/       Corpus acquisition and transformation pipeline
+docker/                Container build definition
+evals/                 Evaluation and smoke checks
+lexicon/               Checkout/runtime literary lexicons
+scripts/               Operational, training, and maintenance commands
+tests/                 Primary automated test suite
+wiki/                  Product idea, history, architecture, and roadmap
+zyntalic/              Installable Python engine
+zyntalic_docs/         Generated language-design reference
+zyntalic-flow/         React/Vite frontend
+```
+
+The [repository guide](wiki/repository-guide.md) defines ownership, safe cleanup practices, legacy directories, and generated artifacts.
+
+## Documentation
+
+- [Project wiki](wiki/README.md)
+- [Architecture](wiki/architecture.md)
+- [Language reference](zyntalic_docs/README.md)
+- [Dataset pipeline](DATASET.md)
+- [Embeddings](EMBEDDINGS.md)
+- [Roadmap](wiki/roadmap.md)
+- [Changelog](CHANGELOG.md)
+- [Security policy](SECURITY.md)
+
+## Scope and limitations
+
+Zyntalic is a creative toolkit, not a linguistically complete English parser or a translation system for a naturally spoken language. The default parser intentionally uses stable heuristics. The generated language reference contains design material that should be backed by executable tests before being treated as a compatibility guarantee.
+
+Corpus and fixture contributions must be redistributable and must not contain personal or confidential information. See [CONTRIBUTING.md](CONTRIBUTING.md#data-and-lexicon-contributions).
+
+## License
+
+Released under the [MIT License](LICENSE).

zyntalic-0.3.0/apps/__init__.py

@@ -0,0 +1 @@
+"""Application entry points for Zyntalic."""

zyntalic-0.3.0/apps/cli/__main__.py

@@ -0,0 +1,4 @@
+from zyntalic.cli import main
+
+if __name__ == '__main__':
+    raise SystemExit(main())

zyntalic-0.3.0/apps/web/__init__.py

@@ -0,0 +1 @@
+"""FastAPI application package."""