numbr 1.0.0__tar.gz

numbr-1.0.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: numbr
+Version: 1.0.0
+Summary: A comprehensive Python library for parsing and converting numbers between numeric, word, and ordinal formats.
+Home-page: https://github.com/cedricmoorejr/numbr/tree/v1.0.0
+Author: Cedric Moore Jr.
+Author-email: cedricmoorejunior5@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# numbr
+
+**numbr** is a Python library designed for parsing and converting numbers written in English. It simplifies working with numbers by converting between spelled-out forms, ordinal forms, and numeric representations.
+
+---
+
+## Key Features
+
+- Convert spelled-out cardinal numbers into integers (e.g., `"one hundred twenty-three"` → `123`).
+- Convert integers into their spelled-out English words (e.g., `123` → `"one hundred twenty-three"`).
+- Convert ordinal words to numeric ordinals (e.g., `"twenty-first"` → `"21st"` or `21`).
+- Extract numeric values from text strings.
+- Handle negative numbers, hyphenated numbers, and large numbers (up to quintillions).
+
+---
+
+## Installation
+
+Install `numbr` using `pip`:
+
+```bash
+pip install numbr
+```
+
+---
+
+## Usage Examples
+
+### Convert Words to Integer
+
+```python
+import numbr
+
+print(numbr.wordsToInt("one thousand two hundred thirty-four"))
+# Output: 1234
+```
+
+### Convert Integer to Words
+
+```python
+print(numbr.intToWords(5678))
+# Output: "five thousand six hundred seventy-eight"
+```
+
+### Convert Ordinal Words to Numeric Form
+
+```python
+print(numbr.ordinalWordsToInt("forty-second"))
+# Output: "42nd"
+
+print(numbr.ordinalWordsToInt("forty-second", to_num=True))
+# Output: 42
+```
+
+### Extract Numeric Values from Strings
+
+```python
+print(numbr.extractNumericValue("I have twenty apples and 13 oranges."))
+# Output: 20
+```
+
+---
+
+## Terminology
+
+- **Cardinal Numbers**: Represent quantity (e.g., "one", "twenty-five", "1,234").
+- **Ordinal Numbers**: Represent position or order (e.g., "first", "twenty-first", "3rd").
+- **Ordinal Suffix**: Letters added to numbers indicating position ("st", "nd", "rd", "th").
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve `numbr`.
+
+---
+
+## Contact
+
+For questions or feedback, please open an issue on the project's GitHub repository.
+

numbr-1.0.0/README.md

@@ -0,0 +1,87 @@
+# numbr
+
+**numbr** is a Python library designed for parsing and converting numbers written in English. It simplifies working with numbers by converting between spelled-out forms, ordinal forms, and numeric representations.
+
+---
+
+## Key Features
+
+- Convert spelled-out cardinal numbers into integers (e.g., `"one hundred twenty-three"` → `123`).
+- Convert integers into their spelled-out English words (e.g., `123` → `"one hundred twenty-three"`).
+- Convert ordinal words to numeric ordinals (e.g., `"twenty-first"` → `"21st"` or `21`).
+- Extract numeric values from text strings.
+- Handle negative numbers, hyphenated numbers, and large numbers (up to quintillions).
+
+---
+
+## Installation
+
+Install `numbr` using `pip`:
+
+```bash
+pip install numbr
+```
+
+---
+
+## Usage Examples
+
+### Convert Words to Integer
+
+```python
+import numbr
+
+print(numbr.wordsToInt("one thousand two hundred thirty-four"))
+# Output: 1234
+```
+
+### Convert Integer to Words
+
+```python
+print(numbr.intToWords(5678))
+# Output: "five thousand six hundred seventy-eight"
+```
+
+### Convert Ordinal Words to Numeric Form
+
+```python
+print(numbr.ordinalWordsToInt("forty-second"))
+# Output: "42nd"
+
+print(numbr.ordinalWordsToInt("forty-second", to_num=True))
+# Output: 42
+```
+
+### Extract Numeric Values from Strings
+
+```python
+print(numbr.extractNumericValue("I have twenty apples and 13 oranges."))
+# Output: 20
+```
+
+---
+
+## Terminology
+
+- **Cardinal Numbers**: Represent quantity (e.g., "one", "twenty-five", "1,234").
+- **Ordinal Numbers**: Represent position or order (e.g., "first", "twenty-first", "3rd").
+- **Ordinal Suffix**: Letters added to numbers indicating position ("st", "nd", "rd", "th").
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve `numbr`.
+
+---
+
+## Contact
+
+For questions or feedback, please open an issue on the project's GitHub repository.
+

numbr-1.0.0/numbr/__init__.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+
+from . import engine as __engine
+
+__all__ = [
+    # "replaceNumericValue",    
+    "wordsToInt",
+    "ordinalSuffix",
+    "intToWords",
+    "intToOrdinalWords",
+    "stripOrdinalSuffix",
+    "ordinalWordsToInt",
+    "stringToInt",
+    "extractNumericValue",
+    "romanToWords",
+    "romanToInt",   
+    "formatDecimal", 
+    "insertSep",     
+]
+
+# Reference functions using __engine alias
+# replaceNumericValue = __engine.replaceNumericValue
+wordsToInt = __engine.wordsToInt
+ordinalSuffix = __engine.ordinalSuffix
+intToWords = __engine.intToWords
+intToOrdinalWords = __engine.intToOrdinalWords
+stripOrdinalSuffix = __engine.stripOrdinalSuffix
+ordinalWordsToInt = __engine.ordinalWordsToInt
+stringToInt = __engine.stringToInt
+extractNumericValue = __engine.extractNumericValue
+romanToWords = __engine.romanToWords
+romanToInt = __engine.romanToInt
+formatDecimal = __engine.formatDecimal
+insertSep = __engine.insertSep
+
+del engine