Skip to main content

A CLI tool for calculating numerology of names

Project description

README.md

Numerology CLI Tool

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

                                ███████╗██╗   ██╗███╗   ██╗
                                ██╔════╝██║   ██║████╗  ██║
                                █████╗  ██║   ██║██╔██╗ ██║
                                ██╔══╝  ██║   ██║██║╚██╗██║
                                ██║     ╚██████╔╝██║ ╚████║
                                ╚═╝      ╚═════╝ ╚═╝  ╚═══╝
                                    ┬┌─┐  ┬ ┬┌─┐┬─┐┌─┐┬
                                    │└─┐  ├─┤├┤ ├┬┘├┤ │
                                    ┴└─┘  ┴ ┴└─┘┴└─└─┘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

Development Version

git clone https://github.com/techy4shri/Numero-Fun.git
cd Numero-Fun
pip install -e .

From PyPI (not done yet!!!)

pip install numero-fun

From Source

git clone https://github.com/yourusername/Numero-Fun.git
cd Numero-Fun
pip install .

Usage

There are three ways to use this tool:

1. Command Line Tool (Recommended)

numero-fun

2. Python Module

python -m numero_fun.cli

3. Python Package

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:

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

Running Tests

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 Licence , more info in LICENCE.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

numero_fun-0.1.1.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

numero_fun-0.1.1-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file numero_fun-0.1.1.tar.gz.

File metadata

  • Download URL: numero_fun-0.1.1.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for numero_fun-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3e98be7b4b8d1090840ae23c8829836cffdf1c21fb1cf17cd03f42ae380e89d0
MD5 32c2bee69421c39c4d9d0686ed8e84cc
BLAKE2b-256 5ee3a8c981e936e69bcc4e1c2331e968bfad64ff8e4d37559863a24ae22a95af

See more details on using hashes here.

File details

Details for the file numero_fun-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: numero_fun-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for numero_fun-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2274136859c2958e90c1cc1fddf1c738831704b09ea13270715df31697f42949
MD5 944647ac66df40c4c3484c7e7f444279
BLAKE2b-256 40e1069e1c902adf77d389c2eed9ce1104819d6f65d789e0c5d3b3c9c176df95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page