Skip to main content

A CLI tool for calculating numerology of names

Project description

README.md

Numerology CLI Tool

PyPI version Python 3.8+ License: GPL v3

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

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

pip install numero-fun

From Source

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)

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/techy4shri/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 License. See LICENSE for details.

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.2.tar.gz (20.7 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.2-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numero_fun-0.1.2.tar.gz
  • Upload date:
  • Size: 20.7 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.2.tar.gz
Algorithm Hash digest
SHA256 4992586708fa1082cb005c98e497565278f6dba328caf4ddd175e3aeda5153ce
MD5 b5ca831feb5a028c8bc99ba28cff83e0
BLAKE2b-256 6003409903ccbe315010c386842f2737f306cc9cf2147ff23af136df16e93342

See more details on using hashes here.

File details

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

File metadata

  • Download URL: numero_fun-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 56c6c43d88a18518143d9bf883c631e0a9aecb6bce92d7e9f9c170799d012e06
MD5 13106444204c7b93024f8933c96917d3
BLAKE2b-256 e2b7b1e23cc10cc0598c4ae74b63ca6a732689db62aa6ce6e80d1f84aabd93ed

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