numero-fun


Namenumero-fun JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryA CLI tool for calculating numerology of names
upload_time2025-08-29 20:38:56
maintainerNone
docs_urlNone
authorGarima Shrivastava
requires_python>=3.8
licenseGPL-3.0
keywords numerology cli calculator
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # README.md

# Numerology CLI Tool

[![PyPI version](https://badge.fury.io/py/numero-fun.svg)](https://pypi.org/project/numero-fun/)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

```
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                    ███╗   ██╗██╗   ██╗███╗   ███╗███████╗██████╗  ██████╗ 
                    ████╗  ██║██║   ██║████╗ ████║██╔════╝██╔══██╗██╔═══██╗
                    ██╔██╗ ██║██║   ██║██╔████╔██║█████╗  ██████╔╝██║   ██║
                    ██║╚██╗██║██║   ██║██║╚██╔╝██║██╔══╝  ██╔══██╗██║   ██║
                    ██║ ╚████║╚██████╔╝██║ ╚═╝ ██║███████╗██║  ██║╚██████╔╝
                    ╚═╝  ╚═══╝ ╚═════╝ ╚═╝     ╚═╝╚══════╝╚═╝  ╚═╝ ╚═════╝

                                ███████╗██╗   ██╗███╗   ██╗
                                ██╔════╝██║   ██║████╗  ██║
                                █████╗  ██║   ██║██╔██╗ ██║
                                ██╔══╝  ██║   ██║██║╚██╗██║
                                ██║     ╚██████╔╝██║ ╚████║
                                ╚═╝      ╚═════╝ ╚═╝  ╚═══╝
                                    ┬┌─┐  ┬ ┬┌─┐┬─┐┌─┐┬
                                    │└─┐  ├─┤├┤ ├┬┘├┤ │
                                    ┴└─┘  ┴ ┴└─┘┴└─└─┘o
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
```
This project is a command-line interface (CLI) tool for calculating the numerology of a name. It started as a practice project for dictionary and OOPS concepts in python but since the dictionary was getting quite lengthy and inefficient (kinda annoying too), I replaced it with a classic modulo math trick :D

## Features

- Calculate the numerology of a given name using three different methods:
  - Modern (Standard numerology 1-9)
  - Chaldean (Ancient system 1-8)
  - Pythagorean (Preserves master numbers 11, 22, 33)
- Interactive method selection using arrow keys
- User-friendly command-line interface with rich formatting
- Supports both uppercase and lowercase input
- Error handling and input validation

## Installation

### From PyPI (Recommended)
```bash
pip install numero-fun
```

### From Source
```bash
git clone https://github.com/techy4shri/Numero-Fun.git
cd Numero-Fun
pip install .
```

## Usage

There are three ways to use this tool:


### 1. Command Line Tool (Recommended)
```bash
numero-fun
```

### 2. Python Module
```bash
python -m numero_fun.cli
```

### 3. Python Package
```python
from numero_fun import calculate_number

result = calculate_number("shri")
print(result)

chaldean_result = calculate_number("john", method="chaldean")
pythagorean_result = calculate_number("john", method="pythagorean")
```

### Example Output
```
╭──────────────────────────────────────────────────╮
│           NUMERO-FUN CALCULATOR                  │
╰──────────────────────────────────────────────────╯

Choose numerology method:
❯ Modern         - Standard numerology (1-9)
  Chaldean       - Ancient system (1-8)
  Pythagorean    - Preserves master numbers

Enter a name to calculate its numeral: SHRI
╭──────────────────────────────────────────────────╮
│ Name: SHRI                                       │
│ Method: Standard numerology (1-9)                │
│ Your Magical Number is: 9                        │
╰──────────────────────────────────────────────────╯

Would you like to try another name? (y/n)
```

## Development

To set up the development environment:

```bash
git clone https://github.com/techy4shri/Numero-Fun.git
cd Numero-Fun
python -m venv .venv
.venv\Scripts\activate  # On Windows
pip install -e ".[dev]"
```

### Running Tests
```bash
pytest
```

## Contributing

Contributions are welcome! Please feel free to:
- Submit a pull request for different numerological calculation logics
- Open an issue if you find a bug
- Suggest new features or improvements

## License

This project is licensed under the GPL-3.0 License. See [LICENSE](https://github.com/techy4shri/Numero-Fun/blob/main/LICENSE) for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "numero-fun",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "numerology, cli, calculator",
    "author": "Garima Shrivastava",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/60/03/409903ccbe315010c386842f2737f306cc9cf2147ff23af136df16e93342/numero_fun-0.1.2.tar.gz",
    "platform": null,
    "description": "# README.md\r\n\r\n# Numerology CLI Tool\r\n\r\n[![PyPI version](https://badge.fury.io/py/numero-fun.svg)](https://pypi.org/project/numero-fun/)\r\n[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)\r\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\r\n\r\n```\r\n\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\r\n                    \u2588\u2588\u2588\u2557   \u2588\u2588\u2557\u2588\u2588\u2557   \u2588\u2588\u2557\u2588\u2588\u2588\u2557   \u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2588\u2588\u2588\u2588\u2557 \r\n                    \u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2551\u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255d\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557\u2588\u2588\u2554\u2550\u2550\u2550\u2588\u2588\u2557\r\n                    \u2588\u2588\u2554\u2588\u2588\u2557 \u2588\u2588\u2551\u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2554\u2588\u2588\u2588\u2588\u2554\u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255d\u2588\u2588\u2551   \u2588\u2588\u2551\r\n                    \u2588\u2588\u2551\u255a\u2588\u2588\u2557\u2588\u2588\u2551\u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2551\u255a\u2588\u2588\u2554\u255d\u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u255d  \u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557\u2588\u2588\u2551   \u2588\u2588\u2551\r\n                    \u2588\u2588\u2551 \u255a\u2588\u2588\u2588\u2588\u2551\u255a\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255d\u2588\u2588\u2551 \u255a\u2550\u255d \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2551  \u2588\u2588\u2551\u255a\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255d\r\n                    \u255a\u2550\u255d  \u255a\u2550\u2550\u2550\u255d \u255a\u2550\u2550\u2550\u2550\u2550\u255d \u255a\u2550\u255d     \u255a\u2550\u255d\u255a\u2550\u2550\u2550\u2550\u2550\u2550\u255d\u255a\u2550\u255d  \u255a\u2550\u255d \u255a\u2550\u2550\u2550\u2550\u2550\u255d\r\n\r\n                                \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2557   \u2588\u2588\u2557\u2588\u2588\u2588\u2557   \u2588\u2588\u2557\r\n                                \u2588\u2588\u2554\u2550\u2550\u2550\u2550\u255d\u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2551\r\n                                \u2588\u2588\u2588\u2588\u2588\u2557  \u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2554\u2588\u2588\u2557 \u2588\u2588\u2551\r\n                                \u2588\u2588\u2554\u2550\u2550\u255d  \u2588\u2588\u2551   \u2588\u2588\u2551\u2588\u2588\u2551\u255a\u2588\u2588\u2557\u2588\u2588\u2551\r\n                                \u2588\u2588\u2551     \u255a\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255d\u2588\u2588\u2551 \u255a\u2588\u2588\u2588\u2588\u2551\r\n                                \u255a\u2550\u255d      \u255a\u2550\u2550\u2550\u2550\u2550\u255d \u255a\u2550\u255d  \u255a\u2550\u2550\u2550\u255d\r\n                                    \u252c\u250c\u2500\u2510  \u252c \u252c\u250c\u2500\u2510\u252c\u2500\u2510\u250c\u2500\u2510\u252c\r\n                                    \u2502\u2514\u2500\u2510  \u251c\u2500\u2524\u251c\u2524 \u251c\u252c\u2518\u251c\u2524 \u2502\r\n                                    \u2534\u2514\u2500\u2518  \u2534 \u2534\u2514\u2500\u2518\u2534\u2514\u2500\u2514\u2500\u2518o\r\n\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\r\n```\r\nThis project is a command-line interface (CLI) tool for calculating the numerology of a name. It started as a practice project for dictionary and OOPS concepts in python but since the dictionary was getting quite lengthy and inefficient (kinda annoying too), I replaced it with a classic modulo math trick :D\r\n\r\n## Features\r\n\r\n- Calculate the numerology of a given name using three different methods:\r\n  - Modern (Standard numerology 1-9)\r\n  - Chaldean (Ancient system 1-8)\r\n  - Pythagorean (Preserves master numbers 11, 22, 33)\r\n- Interactive method selection using arrow keys\r\n- User-friendly command-line interface with rich formatting\r\n- Supports both uppercase and lowercase input\r\n- Error handling and input validation\r\n\r\n## Installation\r\n\r\n### From PyPI (Recommended)\r\n```bash\r\npip install numero-fun\r\n```\r\n\r\n### From Source\r\n```bash\r\ngit clone https://github.com/techy4shri/Numero-Fun.git\r\ncd Numero-Fun\r\npip install .\r\n```\r\n\r\n## Usage\r\n\r\nThere are three ways to use this tool:\r\n\r\n\r\n### 1. Command Line Tool (Recommended)\r\n```bash\r\nnumero-fun\r\n```\r\n\r\n### 2. Python Module\r\n```bash\r\npython -m numero_fun.cli\r\n```\r\n\r\n### 3. Python Package\r\n```python\r\nfrom numero_fun import calculate_number\r\n\r\nresult = calculate_number(\"shri\")\r\nprint(result)\r\n\r\nchaldean_result = calculate_number(\"john\", method=\"chaldean\")\r\npythagorean_result = calculate_number(\"john\", method=\"pythagorean\")\r\n```\r\n\r\n### Example Output\r\n```\r\n\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\r\n\u2502           NUMERO-FUN CALCULATOR                  \u2502\r\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\r\n\r\nChoose numerology method:\r\n\u276f Modern         - Standard numerology (1-9)\r\n  Chaldean       - Ancient system (1-8)\r\n  Pythagorean    - Preserves master numbers\r\n\r\nEnter a name to calculate its numeral: SHRI\r\n\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\r\n\u2502 Name: SHRI                                       \u2502\r\n\u2502 Method: Standard numerology (1-9)                \u2502\r\n\u2502 Your Magical Number is: 9                        \u2502\r\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\r\n\r\nWould you like to try another name? (y/n)\r\n```\r\n\r\n## Development\r\n\r\nTo set up the development environment:\r\n\r\n```bash\r\ngit clone https://github.com/techy4shri/Numero-Fun.git\r\ncd Numero-Fun\r\npython -m venv .venv\r\n.venv\\Scripts\\activate  # On Windows\r\npip install -e \".[dev]\"\r\n```\r\n\r\n### Running Tests\r\n```bash\r\npytest\r\n```\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please feel free to:\r\n- Submit a pull request for different numerological calculation logics\r\n- Open an issue if you find a bug\r\n- Suggest new features or improvements\r\n\r\n## License\r\n\r\nThis project is licensed under the GPL-3.0 License. See [LICENSE](https://github.com/techy4shri/Numero-Fun/blob/main/LICENSE) for details.\r\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "A CLI tool for calculating numerology of names",
    "version": "0.1.2",
    "project_urls": {
        "Homepage": "https://github.com/techy4shri/Numero-Fun",
        "Issues": "https://github.com/techy4shri/Numero-Fun/issues"
    },
    "split_keywords": [
        "numerology",
        " cli",
        " calculator"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e2b7b1e23cc10cc0598c4ae74b63ca6a732689db62aa6ce6e80d1f84aabd93ed",
                "md5": "13106444204c7b93024f8933c96917d3",
                "sha256": "56c6c43d88a18518143d9bf883c631e0a9aecb6bce92d7e9f9c170799d012e06"
            },
            "downloads": -1,
            "filename": "numero_fun-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "13106444204c7b93024f8933c96917d3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 20418,
            "upload_time": "2025-08-29T20:38:54",
            "upload_time_iso_8601": "2025-08-29T20:38:54.982964Z",
            "url": "https://files.pythonhosted.org/packages/e2/b7/b1e23cc10cc0598c4ae74b63ca6a732689db62aa6ce6e80d1f84aabd93ed/numero_fun-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6003409903ccbe315010c386842f2737f306cc9cf2147ff23af136df16e93342",
                "md5": "b5ca831feb5a028c8bc99ba28cff83e0",
                "sha256": "4992586708fa1082cb005c98e497565278f6dba328caf4ddd175e3aeda5153ce"
            },
            "downloads": -1,
            "filename": "numero_fun-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b5ca831feb5a028c8bc99ba28cff83e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 20682,
            "upload_time": "2025-08-29T20:38:56",
            "upload_time_iso_8601": "2025-08-29T20:38:56.843440Z",
            "url": "https://files.pythonhosted.org/packages/60/03/409903ccbe315010c386842f2737f306cc9cf2147ff23af136df16e93342/numero_fun-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-29 20:38:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "techy4shri",
    "github_project": "Numero-Fun",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "numero-fun"
}
        
Elapsed time: 2.13312s