numclassify 0.2.1__tar.gz → 0.3.1__tar.gz

numclassify-0.3.1/.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          pip install mkdocs-material
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

{numclassify-0.2.1 → numclassify-0.3.1}/CHANGELOG.md

@@ -6,6 +6,46 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ---
 
+## [0.3.1] - 2026-06-12
+
+### Added
+- Version number displayed on playground page (fetched live from installed package)
+- Category-colored tags on playground (distinct accent color per property category)
+- Batch classify — enter comma/space-separated numbers for a mini-table of results
+- Recent classification history panel (last 20 numbers, persisted in localStorage)
+- Property tooltips on tag hover (shows category name)
+- Fuzzy search suggestion ("Did you mean X?") on property misspellings
+- Search pagination with "Load More" button (50 results per page)
+- Number of the Day date picker — pick any past date for that day's number
+- Scroll-to-top floating button (appears after 400px scroll)
+- Light theme toggle (sun/moon button, saved to localStorage)
+- Download classification results as JSON file
+- Keyboard shortcut hints displayed on buttons
+
+### Changed
+- Split playground.html into 3 files: HTML skeleton, CSS (~1000 lines), JS (~660 lines)
+- Tab switching now has slide-in animation (translateX + opacity)
+- Result panels slide up on reveal (translateY + opacity)
+- Score counter animates from 0 to final count (cubic ease-out, 400ms)
+- Number digits fade in sequentially (40ms stagger per digit)
+- Score badge pulses green on update
+- Tags enter with random rotation (-3° to +3°) per tag
+- Search results stagger in with 25ms delay per item
+- Buttons have click ripple effect (radial gradient at cursor position)
+- Toast slides in from the right instead of appearing in place
+- All backgrounds and text colors transition smoothly on theme switch
+
+## [0.3.0] - 2026-06-12
+
+### Added
+- Interactive Playground page (docs/playground.html) powered by Pyodide
+- Classifier, property search, number comparison, random number, and Number of the Day features
+- Shareable URLs via ?n=<number> query parameter
+- Copy results to clipboard button
+- Auto-deploy GitHub Pages workflow on every push to main and on version tags
+- Version number now dynamically read from package metadata (single source of truth)
+- PyPI version and downloads badges in README
+
 ## [0.2.0] - 2026-05-11
 
 ### Added

numclassify-0.3.1/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: numclassify
+Version: 0.3.1
+Summary: The most comprehensive Python library for number classification - 3000+ number types
+Project-URL: Homepage, https://github.com/aratrikghosh2011-tech/numclassify
+Project-URL: Repository, https://github.com/aratrikghosh2011-tech/numclassify
+Project-URL: Documentation, https://aratrikghosh2011-tech.github.io/numclassify/
+Project-URL: Issues, https://github.com/aratrikghosh2011-tech/numclassify/issues
+Author-email: Aratrik Ghosh <aratrikghosh2011@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: armstrong,classification,figurate,mathematics,number-theory,prime
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+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 :: Mathematics
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# numclassify
+
+[![PyPI version](https://img.shields.io/pypi/v/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+[![Downloads](https://img.shields.io/pypi/dm/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+[![Python](https://img.shields.io/pypi/pyversions/numclassify?style=flat-square&color=FF9933)](https://pypi.org/project/numclassify/)
+[![Tests](https://img.shields.io/github/actions/workflow/status/aratrikghosh2011-tech/numclassify/ci.yml?label=tests&style=flat-square&color=FF9933)](https://github.com/aratrikghosh2011-tech/numclassify/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-FF9933?style=flat-square)](LICENSE)
+
+**Given a number, what is it?**
+
+Most number-theory libraries — `labmath`, `eulerlib`, `pyntlib` — compute things: factor integers, find GCDs, generate primes. `numclassify` solves a different problem. Hand it a number and it tells you every named mathematical type that number belongs to, across 3000+ categories, with zero external dependencies.
+
+```
+153   →  Armstrong, Harshad, Triangular, Abundant, ...
+1729  →  Taxicab (Hardy-Ramanujan), Carmichael, Zeisel, ...
+28    →  Perfect, Triangular, Hexagonal, Semiprime, ...
+```
+
+Try it in your browser: **[numclassify Playground](https://aratrikghosh2011-tech.github.io/numclassify/playground.html)**
+
+---
+
+## Installation
+
+```bash
+pip install numclassify
+```
+
+Python 3.8+ required. No external dependencies.
+
+---
+
+## Quick Start
+
+```python
+import numclassify as nc
+
+# Boolean checks
+nc.is_prime(17)       # True
+nc.is_perfect(28)     # True
+
+# Classify a single number — returns number, true properties, and a score
+nc.classify(1729)
+# {'number': 1729, 'true_properties': ['Taxicab', 'Carmichael', ...], 'score': 22}
+
+# Batch classify
+nc.classify_batch([6, 28, 496])
+
+# Find numbers in a range with a given property
+nc.find_by_property(start=1, end=1000, Perfect=True)
+# [6, 28, 496]
+
+# Stream over large ranges without loading everything into memory
+for result in nc.stream(1, 1_000_000):
+    if result['score'] > 30:
+        print(result)
+
+# All true properties of a number
+nc.get_true_properties(1729)
+
+# Pretty-print a formatted table
+nc.print_properties(153)
+# ┌─────────────────────────────────────────┐
+# │  Properties of 153                      │
+# ├─────────────────────────────────────────┤
+# │  armstrong         ✓                    │
+# │  harshad           ✓                    │
+# │  triangular        ✓                    │
+# │  ...                                    │
+# └─────────────────────────────────────────┘
+```
+
+---
+
+## CLI
+
+```bash
+# Classify a number
+numclassify check 1729
+
+# JSON output for piping
+numclassify check 153 --json
+
+# Find numbers of a type
+numclassify find armstrong --limit 10
+
+# Filter a range
+numclassify range 1 20 --filter prime
+
+# Compare two numbers
+numclassify compare 6 28
+
+# List all types in a category
+numclassify list --category primes
+
+# Get info and OEIS reference for a type
+numclassify info armstrong
+```
+
+---
+
+## Number Categories
+
+| Category | Count | Examples |
+|---|---|---|
+| Polygonal figurate | ~998 | Triangular, Square, Pentagonal, Chiliagonal |
+| Centered polygonal | ~998 | Centered Triangular, Centered Hexagonal |
+| Prime families | 41 | Twin, Mersenne, Sophie Germain, Wilson, Safe |
+| Digital invariants | 10 | Armstrong, Spy, Harshad, Disarium, Happy, Neon |
+| Divisor-based | 27 | Perfect, Abundant, Weird, Amicable, Practical |
+| Sequences | 15 | Fibonacci, Lucas, Catalan, Bell, Padovan |
+| Powers | 13 | Perfect Square, Taxicab, Sum of Two Squares |
+| Number theory | 14 | Evil, Carmichael, Keith, Autobiographical |
+| Combinatorial | 10 | Factorial, Primorial, Subfactorial |
+| Recreational | 5 | Kaprekar, Automorphic, Palindrome |
+| **Total** | **3000+** | |
+
+---
+
+## Custom Types
+
+The `@register` decorator lets you add your own number types. Once registered, the type appears everywhere — `classify()`, `find_by_property()`, the CLI, all of it.
+
+```python
+from numclassify import register
+
+@register(name="my_type", category="custom")
+def is_my_type(n: int) -> bool:
+    return n > 0 and n % 7 == 0 and str(n)[0] == "4"
+
+import numclassify as nc
+nc.is_my_type(42)           # True
+nc.get_true_properties(42)  # [..., 'my_type', ...]
+```
+
+See [`examples/`](examples/) for runnable scripts covering all major features.
+
+---
+
+## API Reference
+
+| Function | Description |
+|---|---|
+| `classify(n)` | Returns `{number, true_properties, score}` |
+| `classify_batch(numbers)` | Classify a list; returns list of dicts |
+| `random_number(max_n)` | Classify a randomly selected number |
+| `find_by_property(start, end, **filters)` | Numbers in range matching property filters |
+| `stream(start, end)` | Generator — memory-safe range classification |
+| `get_all_properties(n)` | Dict of every type mapped to True/False |
+| `get_true_properties(n)` | List of True property names only |
+| `print_properties(n)` | Pretty-print property table to stdout |
+| `count_properties(n)` | Count of True properties |
+| `most_special_in_range(lo, hi)` | Number in range with the most True properties |
+| `find_in_range(fn, lo, hi)` | Numbers where `fn` returns True |
+| `find_all_in_range(lo, hi)` | Dict mapping each number to its true properties |
+| `register` | Decorator to add custom number types |
+| `is_prime(n)` | Convenience boolean |
+| `is_armstrong(n)` | Convenience boolean |
+| `is_perfect(n)` | Convenience boolean |
+
+Full docs: [aratrikghosh2011-tech.github.io/numclassify](https://aratrikghosh2011-tech.github.io/numclassify/)
+
+---
+
+## License
+
+MIT © 2026 Aratrik Ghosh

numclassify-0.3.1/README.md

@@ -0,0 +1,167 @@
+# numclassify
+
+[![PyPI version](https://img.shields.io/pypi/v/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+[![Downloads](https://img.shields.io/pypi/dm/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+[![Python](https://img.shields.io/pypi/pyversions/numclassify?style=flat-square&color=FF9933)](https://pypi.org/project/numclassify/)
+[![Tests](https://img.shields.io/github/actions/workflow/status/aratrikghosh2011-tech/numclassify/ci.yml?label=tests&style=flat-square&color=FF9933)](https://github.com/aratrikghosh2011-tech/numclassify/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-FF9933?style=flat-square)](LICENSE)
+
+**Given a number, what is it?**
+
+Most number-theory libraries — `labmath`, `eulerlib`, `pyntlib` — compute things: factor integers, find GCDs, generate primes. `numclassify` solves a different problem. Hand it a number and it tells you every named mathematical type that number belongs to, across 3000+ categories, with zero external dependencies.
+
+```
+153   →  Armstrong, Harshad, Triangular, Abundant, ...
+1729  →  Taxicab (Hardy-Ramanujan), Carmichael, Zeisel, ...
+28    →  Perfect, Triangular, Hexagonal, Semiprime, ...
+```
+
+Try it in your browser: **[numclassify Playground](https://aratrikghosh2011-tech.github.io/numclassify/playground.html)**
+
+---
+
+## Installation
+
+```bash
+pip install numclassify
+```
+
+Python 3.8+ required. No external dependencies.
+
+---
+
+## Quick Start
+
+```python
+import numclassify as nc
+
+# Boolean checks
+nc.is_prime(17)       # True
+nc.is_perfect(28)     # True
+
+# Classify a single number — returns number, true properties, and a score
+nc.classify(1729)
+# {'number': 1729, 'true_properties': ['Taxicab', 'Carmichael', ...], 'score': 22}
+
+# Batch classify
+nc.classify_batch([6, 28, 496])
+
+# Find numbers in a range with a given property
+nc.find_by_property(start=1, end=1000, Perfect=True)
+# [6, 28, 496]
+
+# Stream over large ranges without loading everything into memory
+for result in nc.stream(1, 1_000_000):
+    if result['score'] > 30:
+        print(result)
+
+# All true properties of a number
+nc.get_true_properties(1729)
+
+# Pretty-print a formatted table
+nc.print_properties(153)
+# ┌─────────────────────────────────────────┐
+# │  Properties of 153                      │
+# ├─────────────────────────────────────────┤
+# │  armstrong         ✓                    │
+# │  harshad           ✓                    │
+# │  triangular        ✓                    │
+# │  ...                                    │
+# └─────────────────────────────────────────┘
+```
+
+---
+
+## CLI
+
+```bash
+# Classify a number
+numclassify check 1729
+
+# JSON output for piping
+numclassify check 153 --json
+
+# Find numbers of a type
+numclassify find armstrong --limit 10
+
+# Filter a range
+numclassify range 1 20 --filter prime
+
+# Compare two numbers
+numclassify compare 6 28
+
+# List all types in a category
+numclassify list --category primes
+
+# Get info and OEIS reference for a type
+numclassify info armstrong
+```
+
+---
+
+## Number Categories
+
+| Category | Count | Examples |
+|---|---|---|
+| Polygonal figurate | ~998 | Triangular, Square, Pentagonal, Chiliagonal |
+| Centered polygonal | ~998 | Centered Triangular, Centered Hexagonal |
+| Prime families | 41 | Twin, Mersenne, Sophie Germain, Wilson, Safe |
+| Digital invariants | 10 | Armstrong, Spy, Harshad, Disarium, Happy, Neon |
+| Divisor-based | 27 | Perfect, Abundant, Weird, Amicable, Practical |
+| Sequences | 15 | Fibonacci, Lucas, Catalan, Bell, Padovan |
+| Powers | 13 | Perfect Square, Taxicab, Sum of Two Squares |
+| Number theory | 14 | Evil, Carmichael, Keith, Autobiographical |
+| Combinatorial | 10 | Factorial, Primorial, Subfactorial |
+| Recreational | 5 | Kaprekar, Automorphic, Palindrome |
+| **Total** | **3000+** | |
+
+---
+
+## Custom Types
+
+The `@register` decorator lets you add your own number types. Once registered, the type appears everywhere — `classify()`, `find_by_property()`, the CLI, all of it.
+
+```python
+from numclassify import register
+
+@register(name="my_type", category="custom")
+def is_my_type(n: int) -> bool:
+    return n > 0 and n % 7 == 0 and str(n)[0] == "4"
+
+import numclassify as nc
+nc.is_my_type(42)           # True
+nc.get_true_properties(42)  # [..., 'my_type', ...]
+```
+
+See [`examples/`](examples/) for runnable scripts covering all major features.
+
+---
+
+## API Reference
+
+| Function | Description |
+|---|---|
+| `classify(n)` | Returns `{number, true_properties, score}` |
+| `classify_batch(numbers)` | Classify a list; returns list of dicts |
+| `random_number(max_n)` | Classify a randomly selected number |
+| `find_by_property(start, end, **filters)` | Numbers in range matching property filters |
+| `stream(start, end)` | Generator — memory-safe range classification |
+| `get_all_properties(n)` | Dict of every type mapped to True/False |
+| `get_true_properties(n)` | List of True property names only |
+| `print_properties(n)` | Pretty-print property table to stdout |
+| `count_properties(n)` | Count of True properties |
+| `most_special_in_range(lo, hi)` | Number in range with the most True properties |
+| `find_in_range(fn, lo, hi)` | Numbers where `fn` returns True |
+| `find_all_in_range(lo, hi)` | Dict mapping each number to its true properties |
+| `register` | Decorator to add custom number types |
+| `is_prime(n)` | Convenience boolean |
+| `is_armstrong(n)` | Convenience boolean |
+| `is_perfect(n)` | Convenience boolean |
+
+Full docs: [aratrikghosh2011-tech.github.io/numclassify](https://aratrikghosh2011-tech.github.io/numclassify/)
+
+---
+
+## License
+
+MIT © 2026 Aratrik Ghosh

{numclassify-0.2.1 → numclassify-0.3.1}/docs/api.md

@@ -15,6 +15,9 @@ Find numbers matching property filters.
 ## stream(start, end)
 Memory-safe generator over large ranges.
 
+## register(name, category, ...)
+Decorator to register custom number types. See [examples/custom_type.py](https://github.com/aratrikghosh2011-tech/numclassify/blob/main/examples/custom_type.py).
+
 ## Utilities
 - get_all_properties(n)
 - get_true_properties(n)