pythagix 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

pythagix/core.py

@@ -14,85 +14,147 @@ __all__ = [
 ]
 
 
-def is_prime(n: int) -> bool:
-    """Check if a number is prime."""
-    if n <= 1:
+def is_prime(number: int) -> bool:
+    """
+    Check whether a given integer is a prime number.
+
+    Args:
+        number (int): The number to check.
+
+    Returns:
+        bool: True if number is prime, False otherwise.
+    """
+    if number <= 1:
         return False
-    if n == 2:
+    if number == 2:
         return True
-    if n % 2 == 0:
+    if number % 2 == 0:
         return False
-    for i in range(3, isqrt(n) + 1, 2):
-        if n % i == 0:
+    for i in range(3, isqrt(number) + 1, 2):
+        if number % i == 0:
             return False
     return True
 
 
-def filter_primes(numbers: List[int]) -> List[int]:
-    """Return only the prime numbers from the list."""
-    return [n for n in numbers if is_prime(n)]
+def filter_primes(values: List[int]) -> List[int]:
+    """
+    Filter and return the prime numbers from a list.
+
+    Args:
+        values (List[int]): A list of integers.
+
+    Returns:
+        List[int]: A list containing only the prime numbers.
+    """
+    return [num for num in values if is_prime(num)]
+
 
+def nth_prime(position: int) -> int:
+    """
+    Get the N-th prime number (1-based index).
 
-def nth_prime(n: int) -> int:
-    """Return the n-th prime number (1-indexed)."""
-    if n < 1:
-        raise ValueError("Index must be >= 1")
+    Args:
+        position (int): The index (1-based) of the prime number to find.
+
+    Returns:
+        int: The N-th prime number.
+
+    Raises:
+        ValueError: If position < 1.
+    """
+    if position < 1:
+        raise ValueError("Position must be >= 1")
 
     count = 0
     candidate = 2
     while True:
         if is_prime(candidate):
             count += 1
-            if count == n:
+            if count == position:
                 return candidate
         candidate += 1
 
 
-def gcd(numbers: List[int]) -> int:
-    """Return the GCD of a list of numbers."""
-    if not numbers:
-        raise ValueError("List must not be empty")
-    return reduce(math.gcd, numbers)
+def gcd(values: List[int]) -> int:
+    """
+    Compute the greatest common divisor (GCD) of a list of integers.
+
+    Args:
+        values (List[int]): A list of integers.
+
+    Returns:
+        int: The GCD of the numbers.
+
+    Raises:
+        ValueError: If the list is empty.
+    """
+    if not values:
+        raise ValueError("Input list must not be empty")
+    return reduce(math.gcd, values)
 
 
-def is_perfect_square(n: int) -> bool:
-    """Check if a number is a perfect square."""
-    if n < 0:
+def is_perfect_square(number: int) -> bool:
+    """
+    Check whether a number is a perfect square.
+
+    Args:
+        number (int): The number to check.
+
+    Returns:
+        bool: True if the number is a perfect square, False otherwise.
+    """
+    if number < 0:
         return False
-    root = isqrt(n)
-    return root * root == n
+    root = isqrt(number)
+    return root * root == number
+
+
+def count_factors(number: int) -> List[int]:
+    """
+    Return all positive factors of a number.
+
+    Args:
+        number (int): The number whose factors are to be found.
 
+    Returns:
+        List[int]: A sorted list of factors.
 
-def count_factors(n: int) -> List[int]:
-    """Return all factors of a number."""
-    if n <= 0:
+    Raises:
+        ValueError: If number is not positive.
+    """
+    if number <= 0:
         raise ValueError("Number must be positive")
 
     factors = set()
-    for i in range(1, isqrt(n) + 1):
-        if n % i == 0:
+    for i in range(1, isqrt(number) + 1):
+        if number % i == 0:
             factors.add(i)
-            factors.add(n // i)
+            factors.add(number // i)
     return sorted(factors)
 
 
-def triangle_number(n: int) -> int:
-    """Return the n-th triangle number."""
-    if n < 0:
-        raise ValueError("n must be >= 0")
-    return n * (n + 1) // 2
+def triangle_number(index: int) -> int:
+    """
+    Calculate the N-th triangular number.
 
+    Args:
+        index (int): The position (starting from 0) in the triangular number sequence.
+
+    Returns:
+        int: The N-th triangular number.
+
+    Raises:
+        ValueError: If index is negative.
+    """
+    if index < 0:
+        raise ValueError("Index must be >= 0")
+    return index * (index + 1) // 2
 
-# Quick test zone
-if __name__ == "__main__":
 
-    def main():
-        """Function for testing other functions."""
-        print("Primes:", filter_primes([1, 2, 3, 4, 5, 16, 17, 19]))
-        print("5th Prime:", nth_prime(5))
-        print("GCD of [12, 18, 24]:", gcd([12, 18, 24]))
-        print("Is 49 perfect square?", is_perfect_square(49))
-        print("Factors of 28:", count_factors(28))
-        print("7th triangle number:", triangle_number(7))
+def main() -> None:
+    """Tester Function."""
+    ...
 
+
+if __name__ == "__main__":
     main()

pythagix-0.1.7.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: pythagix
+Version: 0.1.7
+Summary: A mathy Python package with utilities like LCM, triangle numbers, etc.
+Author: UltraQuantumScriptor
+License: MIT
+Keywords: math,prime,LCM,triangle numbers,gcd,utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+Dynamic: requires-python
+
+---
+
+# 📦 Pythagix
+
+**Pythagix** is a lightweight and dependency-free Python library designed for number theory operations.
+It provides a clean, efficient interface to common mathematical utilities such as prime number checks, greatest common divisor computation, triangular numbers, and more.
+
+---
+
+## 📥 Installation
+
+Install Pythagix using pip:
+
+```bash
+pip install pythagix
+```
+
+---
+
+## Features
+
+* `is_prime(number: int) -> bool`
+  Determine whether a number is a prime number.
+
+* `filter_primes(numbers: List[int]) -> List[int]`
+  Return all prime numbers from a list of integers.
+
+* `nth_prime(position: int) -> int`
+  Retrieve the *n*-th prime number (1-based indexing).
+
+* `gcd(values: List[int]) -> int`
+  Compute the greatest common divisor (GCD) of a list of integers.
+
+* `is_perfect_square(number: int) -> bool`
+  Check whether a number is a perfect square.
+
+* `count_factors(number: int) -> List[int]`
+  Return a sorted list of all positive factors of a number.
+
+* `triangle_number(index: int) -> int`
+  Compute the *n*-th triangular number.
+
+---
+
+## Example Usage
+
+```python
+from pythagix import is_prime, nth_prime, gcd, triangle_number
+
+print(is_prime(13))         # Output: True
+
+print(nth_prime(10))        # Output: 29
+
+print(gcd([12, 18, 24]))    # Output: 6
+
+print(triangle_number(7))   # Output: 28
+```
+
+---
+
+## Use Cases
+
+Pythagix is ideal for:
+
+* Educational platforms and math-related tools
+
+* Prototyping algorithms and number-theoretic computations
+
+* Teaching foundational concepts in discrete mathematics and number theory
+
+* Lightweight CLI utilities and academic scripting
+
+---
+
+## License
+
+Pythagix is released under the [MIT License](LICENSE), making it free to use, modify, and distribute.
+
+---
+
+## Contributing
+
+Contributions are welcome!
+If you'd like to add features, report bugs, or improve documentation, please open an issue or submit a pull request on the [GitHub repository](https://github.com/your-username/pythagix).
+
+---
+
+If you want me to tailor this even more (e.g. add badges, GitHub Actions, versioning, or PyPI metadata snippets), I can assist with that too.

pythagix-0.1.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+pythagix/__init__.py,sha256=6tpiGil3VFdLrZ9fUZ41YY7qAkNyWOC74fiUNCuXzAE,175
+pythagix/core.py,sha256=-zmDFcEsfqL8G-cEY8CCfw1YA0_fDnRrLv4g-bxeews,3534
+pythagix-0.1.7.dist-info/licenses/LICENSE,sha256=Qv2ilebwoUtMJnRsZwRy729xS5JZQzLauJ0tQzkAkTA,1088
+pythagix-0.1.7.dist-info/METADATA,sha256=8vrKYFwTC1aKvY9_pmd9yLwK8E70qP7mFnfLe9wRz5Q,2679
+pythagix-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pythagix-0.1.7.dist-info/top_level.txt,sha256=U3rm-YGObQkL0gSuVWFPZTakILlqyAd7pUVvtJiMlsE,9
+pythagix-0.1.7.dist-info/RECORD,,

pythagix-0.1.6.dist-info/METADATA

@@ -1,56 +0,0 @@
-Metadata-Version: 2.4
-Name: pythagix
-Version: 0.1.6
-Summary: A mathy Python package with utilities like LCM, triangle numbers, etc.
-Author: UltraQuantumScriptor
-License: MIT
-Keywords: math,prime,LCM,triangle numbers,gcd,utilities
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
-Dynamic: requires-python
-
-Pythagix
-
-Pythagix is a lightweight Python utility library for working with number theory.
-It offers essential math functions like checking primes, computing triangle numbers, finding GCDs, and more — all in a fast, dependency-free package.
-
-Installation
-
-```bash
-pip install pythagix
-```
-Features
-
-is_prime(number) — Check if a number is prime
-
-prime_list(numbers: list) — Return all prime numbers from a list
-
-nth_prime(n) — Get the n-th prime number
-
-gcd(numbers: list) — Compute the greatest common divisor of a list
-
-is_perfect_square(n) — Check if a number is a perfect square
-
-count_factors(n) — Count the total number of factors of a number
-
-triangle_number(n) — Compute the n-th triangle number
-
-Example Usage
-
-```python
-from pythagix import is_prime, nth_prime, gcd, triangle_number
-
-print(is_prime(13))        # True
-print(nth_prime(10))       # 29
-print(gcd([12, 18, 24]))   # 6
-print(triangle_number(7))  # 28
-```
-
-About
-
-Pythagix was built to give students, developers, and math enthusiasts a clean and simple way to explore number theory in Python.
-It is ideal for learning, prototyping, or educational tools.

pythagix-0.1.6.dist-info/RECORD

@@ -1,7 +0,0 @@
-pythagix/__init__.py,sha256=6tpiGil3VFdLrZ9fUZ41YY7qAkNyWOC74fiUNCuXzAE,175
-pythagix/core.py,sha256=RSL6W9NgMGRR3rVkPubpem7errcUFD5RrHF1mdTmDJ8,2425
-pythagix-0.1.6.dist-info/licenses/LICENSE,sha256=Qv2ilebwoUtMJnRsZwRy729xS5JZQzLauJ0tQzkAkTA,1088
-pythagix-0.1.6.dist-info/METADATA,sha256=GiOg5JBsM7Kv7vj1G7EDDUYcOe1PRNaIIj5F9f_W0Do,1659
-pythagix-0.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pythagix-0.1.6.dist-info/top_level.txt,sha256=U3rm-YGObQkL0gSuVWFPZTakILlqyAd7pUVvtJiMlsE,9
-pythagix-0.1.6.dist-info/RECORD,,