numclassify 0.1.0__py3-none-any.whl

numclassify-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,19 @@
+numclassify/__init__.py,sha256=RpyRHSFIvzO0laDBaES9w4obaFgjl63e0RVstx4aies,1847
+numclassify/__main__.py,sha256=Uo95F9uoTqpqCL6wuHTNqjhZgrpQfjasA7qw3GRvfTU,98
+numclassify/_registry.py,sha256=GgDCvO45YN9SOS_k0n6_VZvCM65fS0iL4_4bKnerubw,11310
+numclassify/cli.py,sha256=DXHJdgOuszl6NoK4oSg6tRxIDgnxa8860enEd7iD6Rk,16563
+numclassify/_core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+numclassify/_core/combinatorial.py,sha256=OmdNaXk34538F26pbrYeM_jDfbva2C1oq18S4yp2M58,9973
+numclassify/_core/digital.py,sha256=42PRqCc3Zehcd0LBuf9NDtxGsQa-Sx0jxmZEBPtyxIo,8862
+numclassify/_core/divisors.py,sha256=plem-AnBrAHbgUkqRMFiHM7PkvbMZqGqXdI5Cz-DilM,17233
+numclassify/_core/figurate.py,sha256=X40hLYLxzqco6aMVJ57UlsAKenkPDCU1NlWQw8w6Z9g,11180
+numclassify/_core/number_theory.py,sha256=TpvScMfi2AdaxmYuh_V3nx1WGT0-GVf2G2EvgefxvXY,12168
+numclassify/_core/powers.py,sha256=HbsG7q08SZSSwd25WXbubtHLBn0CEtMABKV1tT01hz8,7767
+numclassify/_core/primes.py,sha256=_KkYA6F4k6eDN8eAthPsrsJg0PlJMS-7k6R5Xfn3h0s,48894
+numclassify/_core/recreational.py,sha256=iPc-7l_0o-pvUG2pF85gxgJKzT_j7n92s78yASS36zU,5957
+numclassify/_core/sequences.py,sha256=sYOIFKfyw8eLdqLbtjJYWWj_J62n7MXtPAY7IociqAA,11220
+numclassify-0.1.0.dist-info/METADATA,sha256=zcKz4rtah0hULoVKlaqRpJ3y3NPk0lRlCnHV1Qe2eyg,7364
+numclassify-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+numclassify-0.1.0.dist-info/entry_points.txt,sha256=R4xPR2lbwwpXfn3udBwhDvwy7JMREW80eeRtM4l9mSs,53
+numclassify-0.1.0.dist-info/licenses/LICENSE,sha256=pXh-SE4Y1rDyH9PkeNkxrPdnNv9ryBNaikhhzG9DJls,1071
+numclassify-0.1.0.dist-info/RECORD,,

numclassify-0.1.0.dist-info/WHEEL

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

numclassify-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+numclassify = numclassify.cli:main

numclassify-0.1.0.dist-info/licenses/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.