lupaxa-text-analyse 0.1.0__tar.gz

lupaxa_text_analyse-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# OS
+.DS_Store
+
+# Cursor
+.cursor/
+.superpowers/
+.worktrees/
+cursor-docs
+
+# Make
+.makefiles/
+
+# Python
+.venv/
+__pycache__/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+build/
+*.egg-info/

lupaxa_text_analyse-0.1.0/LICENCE

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

lupaxa_text_analyse-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: lupaxa-text-analyse
+Version: 0.1.0
+Summary: Analyse prose for readability and source code for rough size and complexity metrics.
+Project-URL: Homepage, https://github.com/lupaxa-developers-toolbox/text-analyse
+Project-URL: Documentation, https://github.com/lupaxa-developers-toolbox/text-analyse
+Project-URL: Repository, https://github.com/lupaxa-developers-toolbox/text-analyse
+Project-URL: Issues, https://github.com/lupaxa-developers-toolbox/text-analyse/issues
+Author: The Lupaxa Project
+License: MIT License
+        
+        Copyright (c) The Lupaxa Project
+        
+        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.
+License-File: LICENCE
+Keywords: analysis,cli,code,readability,text
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: httpx>=0.27
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
+Requires-Dist: hatch>=1.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.12.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://github.com/lupaxa-developers-toolbox">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Developers Toolbox" />
+  </a>
+</p>
+
+<h1 align="center">Text Analyse</h1>
+
+Analyse prose for readability, and source code for rough size and
+complexity metrics. The library returns one result object. The
+`text-analyse` command prints that result as a table.
+
+The PyPI name is `lupaxa-text-analyse`. The import path is
+`lupaxa.text_analyse`. The console script is `text-analyse`. `lupaxa` is
+a namespace package — there is no `lupaxa/__init__.py`.
+
+Public names: `analyse`, `analyse_text`, `analyse_code`, `looks_like_code`,
+`fetch_text`, `describe_flesch_score`, `reading_age_band`,
+`TextAnalyseError`, `FetchError`, `__version__`, `get_version()`.
+
+## Install
+
+```bash
+pip install lupaxa-text-analyse
+```
+
+Requires Python 3.10 or newer, plus `httpx`, `beautifulsoup4`, and `rich`.
+
+## Library
+
+```python
+from lupaxa.text_analyse import analyse, analyse_code, analyse_text, fetch_text
+
+analyse("The cat sat on the mat.")
+analyse(open("README.md", encoding="utf-8").read(), source="README.md")
+analyse_code(open("script.py", encoding="utf-8").read())
+fetch_text("https://example.com")
+```
+
+`analyse` uses `mode="auto"` unless you pass `text` or `code`. Pass
+`source` as the file name when you have one. A documentation suffix
+selects text mode, and a Markdown file is scored after fenced code,
+HTML tags, and link URLs are removed. Text results include the
+reading-age band, the Flesch description, and a language judgement.
+Pass `wpm` to change the reading-time estimate.
+
+`fetch_text` follows redirects, sends a `text-analyse` user-agent, and
+refuses bodies over 2 MB. HTML pages drop navigation, headers, footers,
+and sidebars. The article's headings, paragraphs, and list items become
+the text, with a blank line between them.
+
+> **Note:** Readability scores are for continuous English prose. The
+> syllable counter, sentence splitter, and code metrics are heuristics.
+> Auto mode treats a sample as code when code symbols exceed 3% of the
+> characters. Words such as "for" and "from" do not, on their own. An
+> HTML page, or a Markdown, reStructuredText, or AsciiDoc file, is
+> analysed as text. Markdown scores ignore fenced code, HTML, and link
+> URLs. Pass `--mode code` to force code metrics.
+
+## CLI
+
+The default format is a table. `--format text` prints the same figures
+as aligned lines. `--format json` prints the result object.
+
+```bash
+text-analyse article.txt
+text-analyse --url https://example.com
+text-analyse --min-flesch 60 README.md
+text-analyse docs/ --check --min-flesch 60
+text-analyse --mode code script.py
+cat notes.txt | text-analyse --wpm 180 --reading-age-scheme us
+text-analyse --version
+```
+
+| Flag                   | Meaning                                                 |
+| ---------------------- | ------------------------------------------------------- |
+| `path`                 | Files or documentation directories. Stdin when omitted. |
+| `--file`, `-f`         | File path. Do not combine with `path` or `--url`.       |
+| `--url`, `-u`          | Fetch a URL. HTML is read as the article.               |
+| `--format`, `-F`       | `table` (default), `text`, or `json`.                   |
+| `--mode`, `-m`         | `auto` (default), `text`, or `code`.                    |
+| `--wpm`                | Reading speed for the time estimate (default 200).      |
+| `--min-flesch`         | Fail when the Flesch Reading Ease score is lower.       |
+| `--max-grade`          | Fail when the Flesch–Kincaid grade is higher.           |
+| `--check`              | Print only files that fail a readability threshold.     |
+| `--reading-age-scheme` | `uk` (default) or `us`.                                 |
+| `--version`            | Print `text-analyse x.y.z` and exit `0`.                |
+
+| Result                          | Exit |
+| ------------------------------- | ---- |
+| Report printed                  | `0`  |
+| Readability check failed        | `1`  |
+| Empty input, bad path, or fetch | `1`  |
+| More than one input source      | `1`  |
+| Readability check on code only  | `2`  |
+| `--check` without a threshold   | `2`  |
+
+A single file is one metrics table. It includes the mode, the language
+judgement, and the reading time at the chosen speed. Several files, or a
+directory, print one row per file. A directory is walked for Markdown,
+reStructuredText, AsciiDoc, and plain-text files. `--check` prints only
+the rows that miss a threshold. Code reports for one file are a single
+table with the mode, the line counts, and the file-level complexity heuristic.
+
+## Development
+
+```bash
+make init
+make python-install-dev
+make python-check
+```
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_text_analyse-0.1.0/README.md

@@ -0,0 +1,115 @@
+<p align="center">
+  <a href="https://github.com/lupaxa-developers-toolbox">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Developers Toolbox" />
+  </a>
+</p>
+
+<h1 align="center">Text Analyse</h1>
+
+Analyse prose for readability, and source code for rough size and
+complexity metrics. The library returns one result object. The
+`text-analyse` command prints that result as a table.
+
+The PyPI name is `lupaxa-text-analyse`. The import path is
+`lupaxa.text_analyse`. The console script is `text-analyse`. `lupaxa` is
+a namespace package — there is no `lupaxa/__init__.py`.
+
+Public names: `analyse`, `analyse_text`, `analyse_code`, `looks_like_code`,
+`fetch_text`, `describe_flesch_score`, `reading_age_band`,
+`TextAnalyseError`, `FetchError`, `__version__`, `get_version()`.
+
+## Install
+
+```bash
+pip install lupaxa-text-analyse
+```
+
+Requires Python 3.10 or newer, plus `httpx`, `beautifulsoup4`, and `rich`.
+
+## Library
+
+```python
+from lupaxa.text_analyse import analyse, analyse_code, analyse_text, fetch_text
+
+analyse("The cat sat on the mat.")
+analyse(open("README.md", encoding="utf-8").read(), source="README.md")
+analyse_code(open("script.py", encoding="utf-8").read())
+fetch_text("https://example.com")
+```
+
+`analyse` uses `mode="auto"` unless you pass `text` or `code`. Pass
+`source` as the file name when you have one. A documentation suffix
+selects text mode, and a Markdown file is scored after fenced code,
+HTML tags, and link URLs are removed. Text results include the
+reading-age band, the Flesch description, and a language judgement.
+Pass `wpm` to change the reading-time estimate.
+
+`fetch_text` follows redirects, sends a `text-analyse` user-agent, and
+refuses bodies over 2 MB. HTML pages drop navigation, headers, footers,
+and sidebars. The article's headings, paragraphs, and list items become
+the text, with a blank line between them.
+
+> **Note:** Readability scores are for continuous English prose. The
+> syllable counter, sentence splitter, and code metrics are heuristics.
+> Auto mode treats a sample as code when code symbols exceed 3% of the
+> characters. Words such as "for" and "from" do not, on their own. An
+> HTML page, or a Markdown, reStructuredText, or AsciiDoc file, is
+> analysed as text. Markdown scores ignore fenced code, HTML, and link
+> URLs. Pass `--mode code` to force code metrics.
+
+## CLI
+
+The default format is a table. `--format text` prints the same figures
+as aligned lines. `--format json` prints the result object.
+
+```bash
+text-analyse article.txt
+text-analyse --url https://example.com
+text-analyse --min-flesch 60 README.md
+text-analyse docs/ --check --min-flesch 60
+text-analyse --mode code script.py
+cat notes.txt | text-analyse --wpm 180 --reading-age-scheme us
+text-analyse --version
+```
+
+| Flag                   | Meaning                                                 |
+| ---------------------- | ------------------------------------------------------- |
+| `path`                 | Files or documentation directories. Stdin when omitted. |
+| `--file`, `-f`         | File path. Do not combine with `path` or `--url`.       |
+| `--url`, `-u`          | Fetch a URL. HTML is read as the article.               |
+| `--format`, `-F`       | `table` (default), `text`, or `json`.                   |
+| `--mode`, `-m`         | `auto` (default), `text`, or `code`.                    |
+| `--wpm`                | Reading speed for the time estimate (default 200).      |
+| `--min-flesch`         | Fail when the Flesch Reading Ease score is lower.       |
+| `--max-grade`          | Fail when the Flesch–Kincaid grade is higher.           |
+| `--check`              | Print only files that fail a readability threshold.     |
+| `--reading-age-scheme` | `uk` (default) or `us`.                                 |
+| `--version`            | Print `text-analyse x.y.z` and exit `0`.                |
+
+| Result                          | Exit |
+| ------------------------------- | ---- |
+| Report printed                  | `0`  |
+| Readability check failed        | `1`  |
+| Empty input, bad path, or fetch | `1`  |
+| More than one input source      | `1`  |
+| Readability check on code only  | `2`  |
+| `--check` without a threshold   | `2`  |
+
+A single file is one metrics table. It includes the mode, the language
+judgement, and the reading time at the chosen speed. Several files, or a
+directory, print one row per file. A directory is walked for Markdown,
+reStructuredText, AsciiDoc, and plain-text files. `--check` prints only
+the rows that miss a threshold. Code reports for one file are a single
+table with the mode, the line counts, and the file-level complexity heuristic.
+
+## Development
+
+```bash
+make init
+make python-install-dev
+make python-check
+```
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_text_analyse-0.1.0/docs/README.md

@@ -0,0 +1,23 @@
+<p align="center">
+    <a href="https://github.com/lupaxa-developers-toolbox">
+        <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Organisation Logo" />
+    </a>
+</p>
+
+<h1 align="center">Core Documentation</h1>
+
+The following documents define the standards that apply across **The Lupaxa Project**:
+
+| Document                              | Purpose                                                           |
+| :------------------------------------ | :---------------------------------------------------------------- |
+| [Code of Conduct](CODE_OF_CONDUCT.md) | Expected behaviour and reporting procedures.                      |
+| [How to Contribute](CONTRIBUTING.md)  | Development workflow, coding standards, and contribution process. |
+| [Governance](GOVERNANCE.md)           | Project governance, roles, and decision-making.                   |
+| [Maintainers](MAINTAINERS.md)         | Maintainer responsibilities and expectations.                     |
+| [Projects Overview](PROJECTS.md)      | Overview of organisations, repositories, and project structure.   |
+| [Security Policy](SECURITY.md)        | Responsible disclosure and secure development practices.          |
+| [Support Guide](SUPPORT.md)           | How to obtain help and support.                                   |
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_text_analyse-0.1.0/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["hatchling>=1.18"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lupaxa-text-analyse"
+dynamic = ["version"]
+description = "Analyse prose for readability and source code for rough size and complexity metrics."
+readme = "README.md"
+license = { file = "LICENCE" }
+requires-python = ">=3.10"
+
+authors = [
+  { name = "The Lupaxa Project" }
+]
+
+keywords = ["text", "readability", "code", "cli", "analysis"]
+
+dependencies = [
+  "beautifulsoup4>=4.12",
+  "httpx>=0.27",
+  "rich>=13.0",
+]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Text Processing",
+  "Topic :: Utilities",
+]
+
+[project.urls]
+Homepage = "https://github.com/lupaxa-developers-toolbox/text-analyse"
+Documentation = "https://github.com/lupaxa-developers-toolbox/text-analyse"
+Repository = "https://github.com/lupaxa-developers-toolbox/text-analyse"
+Issues = "https://github.com/lupaxa-developers-toolbox/text-analyse/issues"
+
+[project.scripts]
+text-analyse = "lupaxa.text_analyse.cli:main"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+  "ruff>=0.6.0",
+  "mypy>=1.12.0",
+  "hatch>=1.12.0",
+  "bump-my-version>=1.2.0",
+]
+test = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+]
+
+[tool.hatch.version]
+path = "src/lupaxa/text_analyse/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/**",
+  "README.md",
+  "LICENCE",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lupaxa"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP", "SIM"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["lupaxa"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.10"
+files = ["src", "tests"]
+mypy_path = "src"
+explicit_package_bases = true
+namespace_packages = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = "-ra -q --disable-warnings"
+testpaths = ["tests"]
+pythonpath = ["src"]

lupaxa_text_analyse-0.1.0/src/lupaxa/text_analyse/__init__.py

@@ -0,0 +1,29 @@
+"""lupaxa.text_analyse — readability scores and rough code metrics.
+
+``analyse(text)`` picks prose or code. ``analyse_text`` and ``analyse_code``
+force a mode. ``fetch_text`` downloads a URL and extracts readable text.
+"""
+
+from __future__ import annotations
+
+from lupaxa.text_analyse.code import analyse_code
+from lupaxa.text_analyse.core import analyse
+from lupaxa.text_analyse.detect import looks_like_code
+from lupaxa.text_analyse.exceptions import FetchError, TextAnalyseError
+from lupaxa.text_analyse.fetch import fetch_text
+from lupaxa.text_analyse.text import analyse_text, describe_flesch_score, reading_age_band
+from lupaxa.text_analyse.version import __version__, get_version
+
+__all__ = [
+    "FetchError",
+    "TextAnalyseError",
+    "__version__",
+    "analyse",
+    "analyse_code",
+    "analyse_text",
+    "describe_flesch_score",
+    "fetch_text",
+    "get_version",
+    "looks_like_code",
+    "reading_age_band",
+]

lupaxa_text_analyse-0.1.0/src/lupaxa/text_analyse/__main__.py

@@ -0,0 +1,8 @@
+"""Allow ``python -m lupaxa.text_analyse`` to run the CLI."""
+
+from __future__ import annotations
+
+from lupaxa.text_analyse.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())