pystylometry 0.1.0__py3-none-any.whl

pystylometry-0.1.0.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: pystylometry
+Version: 0.1.0
+Summary: Comprehensive Python package for stylometric analysis
+License: MIT
+Keywords: stylometry,nlp,text-analysis,authorship,readability,lexical-diversity,readability-metrics
+Author: Craig Trim
+Author-email: craigtrim@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Dist: stylometry-ttr (>=1.0.3,<2.0.0)
+Project-URL: Homepage, https://github.com/craigtrim/pystylometry
+Project-URL: Issues, https://github.com/craigtrim/pystylometry/issues
+Project-URL: Repository, https://github.com/craigtrim/pystylometry
+Description-Content-Type: text/markdown
+
+# pystylometry
+
+[![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![PyPI version](https://badge.fury.io/py/pystylometry.svg)](https://badge.fury.io/py/pystylometry)
+
+A comprehensive Python package for stylometric analysis with modular architecture and optional dependencies.
+
+## Features
+
+**pystylometry** provides 50+ metrics across five analysis domains:
+
+- **Lexical Diversity**: TTR, MTLD, Yule's K, Hapax ratios, and more
+- **Readability**: Flesch, SMOG, Gunning Fog, Coleman-Liau, ARI
+- **Syntactic Analysis**: POS ratios, sentence statistics (requires spaCy)
+- **Authorship Attribution**: Burrows' Delta, Cosine Delta, Zeta scores
+- **N-gram Analysis**: Character and word bigram entropy, perplexity
+
+## Installation
+
+Install only what you need:
+
+```bash
+# Core package (lexical metrics only)
+pip install pystylometry
+
+# With readability metrics
+pip install pystylometry[readability]
+
+# With syntactic metrics (requires spaCy)
+pip install pystylometry[syntactic]
+
+# With authorship metrics
+pip install pystylometry[authorship]
+
+# With n-gram analysis
+pip install pystylometry[ngrams]
+
+# Everything
+pip install pystylometry[all]
+```
+
+## Quick Start
+
+### Using Individual Modules
+
+```python
+from pystylometry.lexical import compute_mtld, compute_yule
+from pystylometry.readability import compute_flesch
+
+text = "Your text here..."
+
+# Lexical diversity
+mtld = compute_mtld(text)
+print(f"MTLD: {mtld.mtld_average:.2f}")
+
+yule = compute_yule(text)
+print(f"Yule's K: {yule.yule_k:.2f}")
+
+# Readability
+flesch = compute_flesch(text)
+print(f"Reading Ease: {flesch.reading_ease:.1f}")
+print(f"Grade Level: {flesch.grade_level:.1f}")
+```
+
+### Using the Unified API
+
+```python
+from pystylometry import analyze
+
+text = "Your text here..."
+
+# Analyze with multiple metrics at once
+results = analyze(text, lexical=True, readability=True)
+
+# Access results
+print(f"MTLD: {results.lexical['mtld'].mtld_average:.2f}")
+print(f"Flesch: {results.readability['flesch'].reading_ease:.1f}")
+```
+
+### Checking Available Modules
+
+```python
+from pystylometry import get_available_modules
+
+available = get_available_modules()
+print(available)
+# {'lexical': True, 'readability': True, 'syntactic': False, ...}
+```
+
+## API Design
+
+### Clean, Consistent Interface
+
+Every metric function:
+- Takes text as input
+- Returns a rich result object (never just a float)
+- Includes metadata about the computation
+- Has comprehensive docstrings with formulas and references
+
+```python
+from pystylometry.lexical import compute_yule
+
+result = compute_yule(text)
+# Returns: YuleResult(yule_k=..., yule_i=..., metadata={...})
+```
+
+## Available Metrics
+
+### Lexical Diversity
+- **TTR** - Type-Token Ratio (via stylometry-ttr)
+- **MTLD** - Measure of Textual Lexical Diversity
+- **Yule's K** - Vocabulary repetitiveness
+- **Hapax Legomena** - Words appearing once/twice
+- **Sichel's S** - Hapax-based richness
+- **Honoré's R** - Vocabulary richness constant
+
+### Readability
+- **Flesch Reading Ease** - 0-100 difficulty scale
+- **Flesch-Kincaid Grade** - US grade level
+- **SMOG Index** - Years of education needed
+- **Gunning Fog** - Readability complexity
+- **Coleman-Liau** - Character-based grade level
+- **ARI** - Automated Readability Index
+
+### Syntactic (requires spaCy)
+- **POS Ratios** - Noun/verb/adjective/adverb ratios
+- **Lexical Density** - Content vs function words
+- **Sentence Statistics** - Length, variation, complexity
+
+### Authorship (requires scikit-learn, scipy)
+- **Burrows' Delta** - Author distance measure
+- **Cosine Delta** - Angular distance
+- **Zeta Scores** - Distinctive word usage
+
+### N-grams (requires nltk)
+- **Character Bigram Entropy** - Character predictability
+- **Word Bigram Entropy** - Word sequence predictability
+- **Perplexity** - Language model fit
+
+## Dependencies
+
+**Core (always installed):**
+- stylometry-ttr
+
+**Optional:**
+- `readability`: pronouncing (for syllable counting)
+- `syntactic`: spacy>=3.8.0
+- `authorship`: None (pure Python + stdlib)
+- `ngrams`: None (pure Python + stdlib)
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/craigtrim/pystylometry
+cd pystylometry
+
+# Install with dev dependencies
+pip install -e ".[dev,all]"
+
+# Run tests
+make test
+
+# Run linters
+make lint
+
+# Format code
+make format
+```
+
+## Project Status
+
+🚧 **Phase 1 - Core Lexical Metrics** (In Progress)
+- [x] Project structure
+- [ ] MTLD implementation
+- [ ] Yule's K implementation
+- [ ] Hapax ratios implementation
+- [ ] Tests
+- [ ] v0.1.0 release
+
+See [pystylometry-plan.md](.claude/context/pystylometry-plan.md) for the full roadmap.
+
+## Why pystylometry?
+
+- **Modular**: Install only what you need
+- **Consistent**: Uniform API across all metrics
+- **Rich Results**: Dataclass objects with metadata, not just numbers
+- **Well-Documented**: Formulas, references, and interpretations
+- **Type-Safe**: Full type hints for IDE support
+- **Tested**: Comprehensive test suite
+
+## References
+
+See [stylometry-metrics.md](.claude/context/stylometry-metrics.md) for the complete metrics reference table with formulas.
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Author
+
+Craig Trim (craigtrim@gmail.com)
+
+## Contributing
+
+Contributions welcome! Please open an issue or PR on GitHub.
+

pystylometry-0.1.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+pystylometry/__init__.py,sha256=gCsVT2Eu9sP20Wmq8KQgIf0fEPdZhs-Dlp1IWWfmC5Y,7454
+pystylometry/_types.py,sha256=lldXONgNhTVH5ZGHUVx7BKez7szR8Svi05BSg0M3VsY,3503
+pystylometry/_utils.py,sha256=UN1hBe0WDIov33dG4di7Br9xIIFUwka6SoeOeJ_aGpg,5116
+pystylometry/authorship/__init__.py,sha256=iXkH94lGd5kCDtk1UOuz3gUfOsAJb4DDcv2evTWSCAA,233
+pystylometry/authorship/burrows_delta.py,sha256=6XC8I7EcBTLbn9BNKZsOtL0otL4vKFX10aHBlU4Bki4,5677
+pystylometry/authorship/zeta.py,sha256=oOi9Y6ZPq15ILLVl6So9O9ERvzig26en6_dpQJWeoOc,4338
+pystylometry/lexical/__init__.py,sha256=eHAEzZytevXnR7f1KY3ADrczdmH3YZ2LZCrUx0vXJJw,416
+pystylometry/lexical/hapax.py,sha256=JVwbd7rWe0iy-KGwAGK-PFN7mLhB6xwa4WFvoqGmfMA,2365
+pystylometry/lexical/mtld.py,sha256=tNtvpHKyf_i4E7wTDYZkG6BIkAVbaCOPZpZDApPLtxE,1850
+pystylometry/lexical/yule.py,sha256=XOdGth-E_rCXVp_Y6ZdTXMW2QATw0NoDbNPuXIZFjas,1898
+pystylometry/ngrams/__init__.py,sha256=pJadMr_VAMOENr-CteCqlgokuCP2QIPku7blMj-9ToI,295
+pystylometry/ngrams/entropy.py,sha256=8WT1YaZHRh_0GOEycBzQOzObHZFme5oMf6_lBaEo4ZU,3876
+pystylometry/readability/__init__.py,sha256=kwVGQyxk1e7W7NnZTjwSJ-0pXmyFYeeoNRSt7bpzjoA,346
+pystylometry/readability/ari.py,sha256=Br1ZJAxtoDoT2fFeKRhQuiwyWpobS9E8_wRyizh5w3c,2257
+pystylometry/readability/coleman_liau.py,sha256=weH4w9HSdLxhUiYEub3WgNjKsbSXKMkq-zEZtaqjyU4,2058
+pystylometry/readability/flesch.py,sha256=6YuoS8Qo6KP6enJKMEZ731mMAOKdz2AnVvzZYNVxZHM,2700
+pystylometry/readability/gunning_fog.py,sha256=5x8pntoYMV2pQAnI3-LBm_Od1LJaTcIxnOJ9ESBNRB8,1984
+pystylometry/readability/smog.py,sha256=5Z-PNmJtnsCQTUfv_vnaQdaUAoK0EatCQJW2ypqav6c,2171
+pystylometry/readability/syllables.py,sha256=BuNm9A9ZSzE7kG3qGzhzw47vzui5DAG1nMis6gbwC4k,1373
+pystylometry/syntactic/__init__.py,sha256=8iJRXTu3VTXnoqIIwyLTWlLvxMweq_stG3FkynpoGVM,217
+pystylometry/syntactic/pos_ratios.py,sha256=tzM4y6vqkZp1Jx2L4JzdWtLBegrlqOUgZrohnwjB3H8,1876
+pystylometry/syntactic/sentence_stats.py,sha256=iMOeXhV6VwDt9lKy66pq8i-zQ4JsmdFdNGAsFR5_c48,1825
+pystylometry/tokenizer.py,sha256=03FEF4kKp72v-ypbtMg8u0WyVJGk3YJx6Nw3SGzyAnA,18166
+pystylometry-0.1.0.dist-info/METADATA,sha256=u8t8BmHbeaoDDzTOFicH0YMW5tt3ljStkIai1iwTBK8,6802
+pystylometry-0.1.0.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
+pystylometry-0.1.0.dist-info/RECORD,,

pystylometry-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.0
+Root-Is-Purelib: true
+Tag: py3-none-any