numclassify 0.1.0__tar.gz

numclassify-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest hatchling
+          pip install -e .
+
+      - name: Run tests
+        run: python -m pytest tests/ -v
+
+      - name: Test CLI
+        run: |
+          numclassify check 153
+          numclassify find prime --limit 5
+          numclassify info armstrong

numclassify-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build
+        run: |
+          pip install hatchling build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses OIDC trusted publishing — no API token needed.
+        # Before this workflow can run, go to pypi.org → Your account →
+        # Publishing → Add a new publisher, and fill in:
+        #   GitHub owner:    aratrikghosh2011-tech
+        #   Repository:      numclassify
+        #   Workflow name:   publish.yml
+        #   Environment:     pypi

numclassify-0.1.0/CHANGELOG.txt

@@ -0,0 +1,92 @@
+# Changelog
+
+All notable changes to numclassify will be documented here.
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.1.0] - 2026-04-18
+
+### Added
+
+- Complete package with `@register` decorator plugin architecture — any function
+  decorated with `@register` is automatically available via `get_all_properties`,
+  `get_true_properties`, the CLI, and all search utilities
+- **3000+ number types** across 10 categories, all zero-dependency pure Python
+
+#### Figurate engine
+- Auto-registers 998 polygonal types (triangular through chiliagonal)
+- Auto-registers 998 centered polygonal types (centered triangular through centered chiliagonal)
+- Single parametric generator — adding a new figurate family is one line
+
+#### Prime families (41 types)
+- Standard prime, twin prime, cousin prime, sexy prime
+- Mersenne prime, Mersenne number, double Mersenne prime
+- Sophie Germain prime, safe prime, Cunningham chain member
+- Wilson prime, Fermat prime, Wieferich prime, Wall-Sun-Sun prime
+- Lucky prime, Fortunate prime, Primorial prime
+- Emirp, palindromic prime, permutable prime, circular prime
+- Chen prime, Eisenstein prime, Gaussian prime
+- Titanic prime, gigantic prime, megaprime (digit-count based)
+- OEIS references included in metadata for all 41 types
+
+#### Digital invariants (10 types)
+- Armstrong (narcissistic), Spy number, Harshad (Niven), Disarium
+- Happy number (cycle detection), Neon number, Duck number
+- Nude number (divisible by all its digits), Automorphic, Cyclic
+
+#### Divisor-based (27 types)
+- Perfect, abundant, deficient, weird, pseudoperfect
+- Amicable, sociable (order 4, 6, 8), quasiperfect candidate
+- Practical, semiperfect, primitive abundant
+- Hyperperfect, superperfect, multiply perfect
+- Unitary perfect, bi-unitary perfect, hemiperfect
+- Sublime, sublime-adjacent, colossally abundant, highly abundant
+
+#### Sequences (15 types)
+- Fibonacci, Lucas, Tribonacci, Tetranacci
+- Catalan, Bell, Motzkin, Padovan, Perrin
+- Pell, Jacobsthal, Stern, Recaman
+- Lazy caterer, cake number
+
+#### Powers (13 types)
+- Perfect square, perfect cube, perfect power (any exponent)
+- Taxicab (Hardy-Ramanujan number), generalized taxicab
+- Sum of two squares, sum of three squares, sum of four squares (Lagrange)
+- Powerful number, squarefree, cubefree, k-free
+- Achilles number
+
+#### Number theory (14 types)
+- Evil number, odious number (Thue-Morse based)
+- Carmichael number, Zeisel number, Keith number
+- Autobiographical number, self-describing number
+- Kaprekar number, Kaprekar constant check
+- Economical, equidigital, extravagant (prime factorization digit count)
+- Polydivisible number, pandigital
+
+#### Combinatorial (10 types)
+- Factorial, primorial, subfactorial (derangements)
+- Catalan number (also in sequences), Bell number (also in sequences)
+- Binomial coefficient (any row), central binomial coefficient
+- Catalan's triangle member, Narayana number, Motzkin number
+
+#### Recreational (5 types)
+- Palindrome, near-palindrome
+- Bouncy number (neither increasing nor decreasing digits)
+- Increasing digits, decreasing digits
+
+#### CLI — 5 commands
+- `numclassify check <n>` — all true properties of a number, with `--json` flag
+- `numclassify find <type> --limit <k>` — first k numbers of a given type
+- `numclassify range <lo> <hi> --filter <type>` — filter a range by type
+- `numclassify list --category <cat>` — list all registered types in a category
+- `numclassify info <type>` — name, description, OEIS ref, examples
+
+#### Infrastructure
+- Zero external dependencies; stdlib only
+- Python 3.8–3.13 compatible (tested in CI matrix)
+- 60 pytest tests, all passing
+- GitHub Actions CI across Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
+- PyPI publish via OIDC trusted publishing (no API token)
+- `pyproject.toml` with Hatchling build backend

numclassify-0.1.0/LICENSE

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

numclassify-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: numclassify
+Version: 0.1.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: 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: 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: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# 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/)
+[![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)
+
+---
+
+## Why numclassify?
+
+Most number-theory libraries — `labmath`, `eulerlib`, `pyntlib` — answer *computational* questions: factor this, find the GCD, generate primes up to N.
+
+`numclassify` answers a different question: **what kind of number is this?**
+
+- `153` → Armstrong, Narcissistic, Harshad, Triangular, Abundant…
+- `1729` → Taxicab (Hardy-Ramanujan), Zeisel, Carmichael…
+- `28` → Perfect, Triangular, Hexagonal, Semiprime…
+
+Over **3000 named number types**, instant lookup, no external dependencies.
+
+---
+
+## Installation
+
+```bash
+pip install numclassify
+```
+
+Or clone and install in editable mode:
+
+```bash
+git clone https://github.com/aratrikghosh2011-tech/numclassify.git
+cd numclassify
+pip install -e .
+```
+
+---
+
+## Quick Start
+
+```python
+import numclassify as nc
+
+# Boolean checks
+nc.is_prime(17)          # True
+nc.is_armstrong(153)     # True
+nc.is_perfect(28)        # True
+
+# All true properties of a number
+nc.get_true_properties(1729)
+# ['taxicab', 'zeisel', 'carmichael', 'odd', 'composite',
+#  'deficient', 'squarefree', 'cubefree', 'powerful_not_perfect_power']
+
+# Search a range
+nc.find_in_range(nc.is_armstrong, 1, 10000)
+# [1, 2, 3, 4, 5, 6, 7, 8, 9, 153, 370, 371, 407, 1634, 8208, 9474]
+
+# Pretty-print everything about a number
+nc.print_properties(153)
+# ┌─────────────────────────────────────────┐
+# │  Properties of 153                      │
+# ├─────────────────────────────────────────┤
+# │  armstrong         ✓                    │
+# │  harshad           ✓                    │
+# │  triangular        ✓                    │
+# │  ...                                    │
+# └─────────────────────────────────────────┘
+```
+
+---
+
+## CLI
+
+numclassify ships with a fully-featured command-line interface.
+
+**Check a number:**
+```bash
+$ numclassify check 1729
+1729 properties:
+  taxicab         ✓
+  carmichael      ✓
+  zeisel          ✓
+  odd             ✓
+  deficient       ✓
+  squarefree      ✓
+```
+
+**JSON output (pipe-friendly):**
+```bash
+$ numclassify check 153 --json
+{"armstrong": true, "harshad": true, "triangular": true, "abundant": true, ...}
+```
+
+**Find numbers of a type:**
+```bash
+$ numclassify find armstrong --limit 10
+1, 2, 3, 4, 5, 6, 7, 8, 9, 153
+```
+
+**Filter a range:**
+```bash
+$ numclassify range 1 20 --filter prime
+2, 3, 5, 7, 11, 13, 17, 19
+```
+
+**List all registered types in a category:**
+```bash
+$ numclassify list --category primes
+twin_prime, mersenne_prime, sophie_germain_prime, safe_prime,
+wilson_prime, fermat_prime, ... (41 total)
+```
+
+**Get info about a type:**
+```bash
+$ numclassify info armstrong
+Name:        armstrong
+Category:    digital_invariants
+Description: A number equal to the sum of its digits each raised to the power
+             of the number of digits. Also called narcissistic numbers.
+OEIS:        A005188
+Examples:    1, 2, 3, 153, 370, 371, 407, 1634, 8208, 9474
+```
+
+---
+
+## 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, Catalan… |
+| Recreational | 5 | Kaprekar, Automorphic, Palindrome… |
+| **Total** | **3000+** | |
+
+---
+
+## Adding Your Own Number Type
+
+The `@register` decorator lets you plug in custom types in 6 lines:
+
+```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"
+
+# Now works everywhere
+import numclassify as nc
+nc.is_my_type(49)              # False  (doesn't start with 4)
+nc.is_my_type(42)              # True
+nc.get_true_properties(42)     # [..., 'my_type', ...]
+```
+
+---
+
+## API Reference
+
+| Function | Description |
+|---|---|
+| `is_prime(n)` | Returns `True` if `n` is a standard prime |
+| `is_armstrong(n)` | Returns `True` if `n` is a narcissistic/Armstrong number |
+| `get_all_properties(n)` | Dict of every registered type → `True`/`False` |
+| `get_true_properties(n)` | List of only the properties that are `True` |
+| `print_properties(n)` | Pretty-prints a formatted property table to stdout |
+| `find_in_range(fn, lo, hi)` | All integers in `[lo, hi]` where `fn` returns `True` |
+| `find_all_in_range(lo, hi)` | Dict mapping every number in range to its true properties |
+| `count_properties(n)` | Count of how many types apply to `n` |
+| `most_special_in_range(lo, hi)` | The number in `[lo, hi]` with the most true properties |
+
+Full API docs: [github.com/aratrikghosh2011-tech/numclassify](https://github.com/aratrikghosh2011-tech/numclassify)
+
+---
+
+## Requirements
+
+- Python 3.8 or higher
+- Zero external dependencies
+
+---
+
+## License
+
+MIT © 2026 Aratrik Ghosh

numclassify-0.1.0/README.md

@@ -0,0 +1,194 @@
+# 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/)
+[![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)
+
+---
+
+## Why numclassify?
+
+Most number-theory libraries — `labmath`, `eulerlib`, `pyntlib` — answer *computational* questions: factor this, find the GCD, generate primes up to N.
+
+`numclassify` answers a different question: **what kind of number is this?**
+
+- `153` → Armstrong, Narcissistic, Harshad, Triangular, Abundant…
+- `1729` → Taxicab (Hardy-Ramanujan), Zeisel, Carmichael…
+- `28` → Perfect, Triangular, Hexagonal, Semiprime…
+
+Over **3000 named number types**, instant lookup, no external dependencies.
+
+---
+
+## Installation
+
+```bash
+pip install numclassify
+```
+
+Or clone and install in editable mode:
+
+```bash
+git clone https://github.com/aratrikghosh2011-tech/numclassify.git
+cd numclassify
+pip install -e .
+```
+
+---
+
+## Quick Start
+
+```python
+import numclassify as nc
+
+# Boolean checks
+nc.is_prime(17)          # True
+nc.is_armstrong(153)     # True
+nc.is_perfect(28)        # True
+
+# All true properties of a number
+nc.get_true_properties(1729)
+# ['taxicab', 'zeisel', 'carmichael', 'odd', 'composite',
+#  'deficient', 'squarefree', 'cubefree', 'powerful_not_perfect_power']
+
+# Search a range
+nc.find_in_range(nc.is_armstrong, 1, 10000)
+# [1, 2, 3, 4, 5, 6, 7, 8, 9, 153, 370, 371, 407, 1634, 8208, 9474]
+
+# Pretty-print everything about a number
+nc.print_properties(153)
+# ┌─────────────────────────────────────────┐
+# │  Properties of 153                      │
+# ├─────────────────────────────────────────┤
+# │  armstrong         ✓                    │
+# │  harshad           ✓                    │
+# │  triangular        ✓                    │
+# │  ...                                    │
+# └─────────────────────────────────────────┘
+```
+
+---
+
+## CLI
+
+numclassify ships with a fully-featured command-line interface.
+
+**Check a number:**
+```bash
+$ numclassify check 1729
+1729 properties:
+  taxicab         ✓
+  carmichael      ✓
+  zeisel          ✓
+  odd             ✓
+  deficient       ✓
+  squarefree      ✓
+```
+
+**JSON output (pipe-friendly):**
+```bash
+$ numclassify check 153 --json
+{"armstrong": true, "harshad": true, "triangular": true, "abundant": true, ...}
+```
+
+**Find numbers of a type:**
+```bash
+$ numclassify find armstrong --limit 10
+1, 2, 3, 4, 5, 6, 7, 8, 9, 153
+```
+
+**Filter a range:**
+```bash
+$ numclassify range 1 20 --filter prime
+2, 3, 5, 7, 11, 13, 17, 19
+```
+
+**List all registered types in a category:**
+```bash
+$ numclassify list --category primes
+twin_prime, mersenne_prime, sophie_germain_prime, safe_prime,
+wilson_prime, fermat_prime, ... (41 total)
+```
+
+**Get info about a type:**
+```bash
+$ numclassify info armstrong
+Name:        armstrong
+Category:    digital_invariants
+Description: A number equal to the sum of its digits each raised to the power
+             of the number of digits. Also called narcissistic numbers.
+OEIS:        A005188
+Examples:    1, 2, 3, 153, 370, 371, 407, 1634, 8208, 9474
+```
+
+---
+
+## 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, Catalan… |
+| Recreational | 5 | Kaprekar, Automorphic, Palindrome… |
+| **Total** | **3000+** | |
+
+---
+
+## Adding Your Own Number Type
+
+The `@register` decorator lets you plug in custom types in 6 lines:
+
+```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"
+
+# Now works everywhere
+import numclassify as nc
+nc.is_my_type(49)              # False  (doesn't start with 4)
+nc.is_my_type(42)              # True
+nc.get_true_properties(42)     # [..., 'my_type', ...]
+```
+
+---
+
+## API Reference
+
+| Function | Description |
+|---|---|
+| `is_prime(n)` | Returns `True` if `n` is a standard prime |
+| `is_armstrong(n)` | Returns `True` if `n` is a narcissistic/Armstrong number |
+| `get_all_properties(n)` | Dict of every registered type → `True`/`False` |
+| `get_true_properties(n)` | List of only the properties that are `True` |
+| `print_properties(n)` | Pretty-prints a formatted property table to stdout |
+| `find_in_range(fn, lo, hi)` | All integers in `[lo, hi]` where `fn` returns `True` |
+| `find_all_in_range(lo, hi)` | Dict mapping every number in range to its true properties |
+| `count_properties(n)` | Count of how many types apply to `n` |
+| `most_special_in_range(lo, hi)` | The number in `[lo, hi]` with the most true properties |
+
+Full API docs: [github.com/aratrikghosh2011-tech/numclassify](https://github.com/aratrikghosh2011-tech/numclassify)
+
+---
+
+## Requirements
+
+- Python 3.8 or higher
+- Zero external dependencies
+
+---
+
+## License
+
+MIT © 2026 Aratrik Ghosh

numclassify-0.1.0/numclassify/__init__.py

@@ -0,0 +1,63 @@
+"""
+numclassify
+~~~~~~~~~~~
+The most comprehensive Python library for number classification.
+Importing this package triggers registration of all built-in classification
+functions via their ``@register`` decorators.
+
+Public API
+----------
+.. autosummary::
+   is_prime
+   is_armstrong
+   is_perfect
+   get_all_properties
+   get_true_properties
+   print_properties
+   find_in_range
+   find_all_in_range
+   count_properties
+   most_special_in_range
+"""
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+# --- Import all _core submodules so @register decorators fire at import time ---
+from numclassify._core import primes        # noqa: F401
+from numclassify._core import figurate      # noqa: F401
+from numclassify._core import digital       # noqa: F401
+from numclassify._core import recreational  # noqa: F401
+from numclassify._core import divisors      # noqa: F401
+from numclassify._core import sequences     # noqa: F401
+from numclassify._core import powers        # noqa: F401
+from numclassify._core import number_theory # noqa: F401
+from numclassify._core import combinatorial # noqa: F401
+
+# --- Re-export key functions at top level ---
+from numclassify._core.primes import is_prime         # noqa: F401
+from numclassify._core.digital import is_armstrong    # noqa: F401
+from numclassify._core.divisors import is_perfect     # noqa: F401
+from numclassify._registry import (                   # noqa: F401
+    get_all_properties,
+    get_true_properties,
+    print_properties,
+    find_in_range,
+    find_all_in_range,
+    count_properties,
+    most_special_in_range,
+)
+
+__all__ = [
+    "__version__",
+    "is_prime",
+    "is_armstrong",
+    "is_perfect",
+    "get_all_properties",
+    "get_true_properties",
+    "print_properties",
+    "find_in_range",
+    "find_all_in_range",
+    "count_properties",
+    "most_special_in_range",
+]

numclassify-0.1.0/numclassify/__main__.py

@@ -0,0 +1,4 @@
+"""Allow ``python -m numclassify`` to invoke the CLI."""
+from numclassify.cli import main
+
+main()