numclassify 0.2.0__tar.gz → 0.3.0__tar.gz

numclassify-0.3.0/.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.0 → numclassify-0.3.0}/.gitignore

@@ -9,3 +9,4 @@ dist/
 *.egg-info/
 .env
 .venv 
+site/

{numclassify-0.2.0 → numclassify-0.3.0}/CHANGELOG.md

@@ -6,6 +6,17 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ---
 
+## [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.0/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to numclassify
+
+## Adding a New Number Type
+
+The fastest way to contribute is adding a new number type using the `@register` decorator.
+
+### Step 1 \u2014 Write your function
+
+```python
+from numclassify import register
+
+@register(name="My Type", category="recreational")
+def is_my_type(n: int) -> bool:
+    return n > 0 and n % 7 == 0
+```
+
+That's it. Your type is now available via:
+- `nc.get_all_properties(n)`
+- `nc.get_true_properties(n)`
+- `nc.find_in_range(nc.is_my_type, 1, 1000)`
+- `numclassify find my_type` in the CLI
+
+### Step 2 \u2014 Add it to the right module
+
+Place your function in the appropriate file under `numclassify/_core/`:
+
+| Module | Types |
+|---|---|
+| `primes.py` | Prime families |
+| `figurate.py` | Polygonal/figurate numbers |
+| `divisors.py` | Divisor-based (perfect, abundant...) |
+| `digital.py` | Digit-based (Armstrong, Harshad...) |
+| `sequences.py` | Number sequences (Fibonacci, Lucas...) |
+| `powers.py` | Powers and sums |
+| `number_theory.py` | Number theory properties |
+| `combinatorial.py` | Combinatorial numbers |
+| `recreational.py` | Recreational/fun types |
+
+### Step 3 \u2014 Add a test
+
+Add a test in `tests/` following the existing pattern:
+
+```python
+def test_is_my_type():
+    assert nc.is_my_type(7) == True
+    assert nc.is_my_type(1) == False
+```
+
+### Step 4 \u2014 Submit a PR
+
+```bash
+git checkout -b add-my-type
+git add .
+git commit -m "Add My Type number classification"
+git push origin add-my-type
+```
+
+Then open a pull request on GitHub.
+
+## Running Tests
+
+```bash
+cd numclassify
+python -m pytest tests/ -v
+```
+
+## Code Style
+
+- Pure Python, no external dependencies
+- Type hints required on all functions
+- Function name must start with `is_` for boolean classifiers

{numclassify-0.2.0 → numclassify-0.3.0}/PKG-INFO

@@ -1,15 +1,16 @@
 Metadata-Version: 2.4
 Name: numclassify
-Version: 0.2.0
-Summary: The most comprehensive Python library for number classification — 3000+ number types
+Version: 0.3.0
+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 :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
@@ -20,12 +21,16 @@ 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/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+
 The most comprehensive Python library for number classification — 3000+ number types, zero dependencies.
 
 [![PyPI version](https://img.shields.io/pypi/v/numclassify)](https://pypi.org/project/numclassify/)
@@ -33,6 +38,9 @@ The most comprehensive Python library for number classification — 3000+ number
 [![Python versions](https://img.shields.io/pypi/pyversions/numclassify)](https://pypi.org/project/numclassify/)
 [![License MIT](https://img.shields.io/badge/license-MIT-blue)](https://github.com/aratrikghosh2011-tech/numclassify/blob/main/LICENSE)
 [![Tests](https://img.shields.io/github/actions/workflow/status/aratrikghosh2011-tech/numclassify/ci.yml?label=tests)](https://github.com/aratrikghosh2011-tech/numclassify/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/numclassify?label=version)](https://pypi.org/project/numclassify/)
+
+> **Latest version: 0.2.1** — See [CHANGELOG](CHANGELOG.md) for what's new.
 
 ---
 
@@ -210,12 +218,20 @@ nc.is_my_type(42)              # True
 nc.get_true_properties(42)     # [..., 'my_type', ...]
 ```
 
+See the [`examples/`](examples/) folder for runnable scripts demonstrating all major features:
+- [`basic_usage.py`](examples/basic_usage.py) — classify, batch, streaming
+- [`custom_type.py`](examples/custom_type.py) — registering custom types
+- [`find_perfect_numbers.py`](examples/find_perfect_numbers.py) — property-based search
+- [`stream_large_range.py`](examples/stream_large_range.py) — memory-safe range streaming
+- [`random_classify.py`](examples/random_classify.py) — random number classification
+
 ---
 
 ## API Reference
 
 | Function | Description |
 |---|---|
+| `register(name, category, ...)` | Decorator to add custom number types to the full API |
 | `classify(n)` | Returns a dict with the number, its true properties, and a score |
 | `classify_batch(numbers)` | Classify a list of numbers; returns a list of dicts |
 | `random_number(max_n)` | Classify a randomly selected number up to `max_n` |

{numclassify-0.2.0 → numclassify-0.3.0}/README.md

@@ -1,5 +1,8 @@
 # numclassify
 
+[![PyPI version](https://img.shields.io/pypi/v/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/numclassify.svg?color=FF9933&style=flat-square)](https://pypi.org/project/numclassify/)
+
 The most comprehensive Python library for number classification — 3000+ number types, zero dependencies.
 
 [![PyPI version](https://img.shields.io/pypi/v/numclassify)](https://pypi.org/project/numclassify/)
@@ -7,6 +10,9 @@ The most comprehensive Python library for number classification — 3000+ number
 [![Python versions](https://img.shields.io/pypi/pyversions/numclassify)](https://pypi.org/project/numclassify/)
 [![License MIT](https://img.shields.io/badge/license-MIT-blue)](https://github.com/aratrikghosh2011-tech/numclassify/blob/main/LICENSE)
 [![Tests](https://img.shields.io/github/actions/workflow/status/aratrikghosh2011-tech/numclassify/ci.yml?label=tests)](https://github.com/aratrikghosh2011-tech/numclassify/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/numclassify?label=version)](https://pypi.org/project/numclassify/)
+
+> **Latest version: 0.2.1** — See [CHANGELOG](CHANGELOG.md) for what's new.
 
 ---
 
@@ -184,12 +190,20 @@ nc.is_my_type(42)              # True
 nc.get_true_properties(42)     # [..., 'my_type', ...]
 ```
 
+See the [`examples/`](examples/) folder for runnable scripts demonstrating all major features:
+- [`basic_usage.py`](examples/basic_usage.py) — classify, batch, streaming
+- [`custom_type.py`](examples/custom_type.py) — registering custom types
+- [`find_perfect_numbers.py`](examples/find_perfect_numbers.py) — property-based search
+- [`stream_large_range.py`](examples/stream_large_range.py) — memory-safe range streaming
+- [`random_classify.py`](examples/random_classify.py) — random number classification
+
 ---
 
 ## API Reference
 
 | Function | Description |
 |---|---|
+| `register(name, category, ...)` | Decorator to add custom number types to the full API |
 | `classify(n)` | Returns a dict with the number, its true properties, and a score |
 | `classify_batch(numbers)` | Classify a list of numbers; returns a list of dicts |
 | `random_number(max_n)` | Classify a randomly selected number up to `max_n` |

{numclassify-0.2.0 → numclassify-0.3.0}/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)