birth-teller


Namebirth-teller JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryA Python package to calculate birthdays and zodiac info
upload_time2025-08-20 09:53:17
maintainerNone
docs_urlNone
authorNone
requires_python>=3.0
licenseGPL-3.0
keywords birthday day birthday week day
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Birth Teller

[![PyPI version](https://img.shields.io/pypi/v/birth-teller.svg)](https://pypi.org/project/birth-teller/)
[![License](https://img.shields.io/pypi/l/birth-teller.svg)](https://github.com/exeebit/birth-teller/blob/main/LICENSE)

**Birth Teller** is a lightweight Python library and optional CLI tool that calculates your age, birthday details, and the day of the week you were born. It supports full month names, 3-letter abbreviations, and numeric month input. Perfect for Python projects, scripts, or Django apps.

---

## Features

- Compute age in **years, months, weeks, days, hours, minutes, and seconds**  
- Determine the **day of the week** for any birthdate  
- Supports **full month names**, **3-letter abbreviations**, and **numeric month input**  
- Optional **CLI** for quick terminal usage  
- Fully **importable as a Python library** for projects like Django  

---

## Installation

```bash
pip install birth-teller
```

## Library Usage (Python / Django / Scripts)

```bash
from birth_teller import BTM

# Create an instance
btm = BTM()

# Get birthday information
info = btm.information(8, "feb", 1999)

print(f"You were born on {info['weekDay']}")
print(f"Age in years: {info['years']}")
print(f"Age in days: {info['days']}")
```

### Using different month formats
```bash
# Full month name
info = btm.information(8, "February", 1999)

# 3-letter abbreviation
info = btm.information(8, "feb", 1999)

# Numeric month
info = btm.information(8, 2, 1999)
```
> [!NOTE]
> Works anywhere in Python, including Django views, scripts, or APIs.

### CLI Usage (Optional)
```bash
birth-teller --name Emran --day 8 --month feb --year 1999 // or
birth-teller -n Emran -d 8 -m feb -y 1999
```
### Example Output (CLI)

```bash
You were born on MONDAY
Years: 26
Days: 9690
Weeks: 1384
Zodiac Sign: Capricorn

```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "birth-teller",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": null,
    "keywords": "birthday, day, birthday, week day",
    "author": null,
    "author_email": "Emran Hossain Sagor <imrans4gor@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/fd/f2/dd4698063e263430b4049b21f54f0208159ea33ef6a52dd61d9e1d004668/birth_teller-0.2.0.tar.gz",
    "platform": null,
    "description": "# Birth Teller\n\n[![PyPI version](https://img.shields.io/pypi/v/birth-teller.svg)](https://pypi.org/project/birth-teller/)\n[![License](https://img.shields.io/pypi/l/birth-teller.svg)](https://github.com/exeebit/birth-teller/blob/main/LICENSE)\n\n**Birth Teller** is a lightweight Python library and optional CLI tool that calculates your age, birthday details, and the day of the week you were born. It supports full month names, 3-letter abbreviations, and numeric month input. Perfect for Python projects, scripts, or Django apps.\n\n---\n\n## Features\n\n- Compute age in **years, months, weeks, days, hours, minutes, and seconds**  \n- Determine the **day of the week** for any birthdate  \n- Supports **full month names**, **3-letter abbreviations**, and **numeric month input**  \n- Optional **CLI** for quick terminal usage  \n- Fully **importable as a Python library** for projects like Django  \n\n---\n\n## Installation\n\n```bash\npip install birth-teller\n```\n\n## Library Usage (Python / Django / Scripts)\n\n```bash\nfrom birth_teller import BTM\n\n# Create an instance\nbtm = BTM()\n\n# Get birthday information\ninfo = btm.information(8, \"feb\", 1999)\n\nprint(f\"You were born on {info['weekDay']}\")\nprint(f\"Age in years: {info['years']}\")\nprint(f\"Age in days: {info['days']}\")\n```\n\n### Using different month formats\n```bash\n# Full month name\ninfo = btm.information(8, \"February\", 1999)\n\n# 3-letter abbreviation\ninfo = btm.information(8, \"feb\", 1999)\n\n# Numeric month\ninfo = btm.information(8, 2, 1999)\n```\n> [!NOTE]\n> Works anywhere in Python, including Django views, scripts, or APIs.\n\n### CLI Usage (Optional)\n```bash\nbirth-teller --name Emran --day 8 --month feb --year 1999 // or\nbirth-teller -n Emran -d 8 -m feb -y 1999\n```\n### Example Output (CLI)\n\n```bash\nYou were born on MONDAY\nYears: 26\nDays: 9690\nWeeks: 1384\nZodiac Sign: Capricorn\n\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "A Python package to calculate birthdays and zodiac info",
    "version": "0.2.0",
    "project_urls": {
        "Changelog": "https://github.com/exeebit/birth-teller/blob/main/CHANGELOG.md",
        "Issues": "https://github.com/exeebit/birth-teller/issues",
        "Repository": "https://github.com/exeebit/birth-teller"
    },
    "split_keywords": [
        "birthday",
        " day",
        " birthday",
        " week day"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3e18b79d5e0abc374acce0f10ca0382b200c3a652278a4264472a4d1dbe1e944",
                "md5": "29e445ccaf449ef64b374a09b9327b5b",
                "sha256": "d26f976fc7175027464c9bbb41b4889150734c9fd2b395e3cd0df0145e035979"
            },
            "downloads": -1,
            "filename": "birth_teller-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29e445ccaf449ef64b374a09b9327b5b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.0",
            "size": 16927,
            "upload_time": "2025-08-20T09:53:16",
            "upload_time_iso_8601": "2025-08-20T09:53:16.136441Z",
            "url": "https://files.pythonhosted.org/packages/3e/18/b79d5e0abc374acce0f10ca0382b200c3a652278a4264472a4d1dbe1e944/birth_teller-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fdf2dd4698063e263430b4049b21f54f0208159ea33ef6a52dd61d9e1d004668",
                "md5": "89a6b6f5daa682b3244e32bdd81a5141",
                "sha256": "01c4dc98da2a285e20a633035e30a856bf04fdebd5564682cfe56be6f112598f"
            },
            "downloads": -1,
            "filename": "birth_teller-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "89a6b6f5daa682b3244e32bdd81a5141",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 16443,
            "upload_time": "2025-08-20T09:53:17",
            "upload_time_iso_8601": "2025-08-20T09:53:17.843116Z",
            "url": "https://files.pythonhosted.org/packages/fd/f2/dd4698063e263430b4049b21f54f0208159ea33ef6a52dd61d9e1d004668/birth_teller-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 09:53:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "exeebit",
    "github_project": "birth-teller",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "birth-teller"
}
        
Elapsed time: 1.04826s