weathora


Nameweathora JSON
Version 0.0.3 PyPI version JSON
download
home_pageNone
SummaryA Python CLI tool to fetch live weather data using OpenWeather API
upload_time2025-09-10 07:52:10
maintainerNone
docs_urlNone
authorIshan Bhat
requires_python>=3.6
licenseNone
keywords weather cli python-cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Weathora <!-- omit in toc -->

A simple Python CLI tool to fetch live weather data from any city using the OpenWeather API.

[![PyPI version](https://img.shields.io/pypi/v/weathora.svg?color=blue)](https://pypi.org/project/weathora/)
[![Python Versions](https://img.shields.io/pypi/pyversions/weathora.svg)](https://pypi.org/project/weathora/)
[![License](https://img.shields.io/github/license/bhatishan2003/asciigenator)](LICENSE)
[![CI](https://github.com/bhatishan2003/weathora/actions/workflows/python-app.yml/badge.svg)](https://github.com/bhatishan2003/weathora/actions/workflows/python-app.yml)
[![Build and Deploy Sphinx Docs](https://github.com/bhatishan2003/weathora/actions/workflows/sphinx.yml/badge.svg)](https://github.com/bhatishan2003/weathora/actions/workflows/sphinx.yml)

## Table of Contents <!-- omit in toc -->

-   [Installation](#installation)
    -   [Create and activate a virtual environment:](#create-and-activate-a-virtual-environment)
-   [Setup API Key 🔑](#setup-api-key-)
    -   [Step 1: Create an Account](#step-1-create-an-account)
    -   [Step 2: Get Your API Key](#step-2-get-your-api-key)
    -   [Step 3: Store the API Key](#step-3-store-the-api-key)
        -   [🔹 PowerShell](#-powershell)
        -   [🔹Bash](#bash)
-   [Usage](#usage)
    -   [Command Line Usage](#command-line-usage)

---

## Installation

-   From pip

    ```bash
    pip install weathora
    ```

-   Clone the repository:

    ```bash
    git clone https://github.com/bhatishan2003/weathora
    cd weathora
    ```

### Create and activate a virtual environment:

1. **Create a Virtual Environment [Optional, but recommended]**

    Run the following command to create a [virtual environment](https://docs.python.org/3/library/venv.html):

    ```bash
    python3 -m venv .venv
    ```

-   **Activate:**

    -   **Windows (PowerShell):**

        ```bash
        .venv\Scripts\activate
        ```

    -   **Linux/Mac (Bash):**

        ```bash
        source .venv/bin/activate
        ```

-   **Deactivate:**

    ```bash
    deactivate
    ```

-   **Install the package:**

    ```bash
    pip install .
    ```

-   **For development (editable mode):**

    ```bash
    pip install -e .
    ```

## Setup API Key 🔑

To use this project, you’ll need an API key from **OpenWeather**.

### Step 1: Create an Account

1. Go to [OpenWeather API](https://home.openweathermap.org/).
2. Sign up (or log in if you already have an account).

### Step 2: Get Your API Key

1. Navigate to your **API Keys** section in the OpenWeather dashboard.
2. Copy your **API Key**.

### Step 3: Store the API Key

Depending on your shell, use one of the following commands:

#### 🔹 PowerShell

```powershell
$Env:OPENWEATHER_API_KEY = "YOUR_SECRET_KEY"
```

#### 🔹Bash

```bash
export OPENWEATHER_API_KEY="YOUR_SECRET_KEY"
```

## Usage

### Command Line Usage

-   Following commands should be entered to get weather information.

    ```powershell
    weathora --city "Delhi"
    weathora --city "London"
    weathora --city "Jammu"
    ```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "weathora",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "weather cli python-cli",
    "author": "Ishan Bhat",
    "author_email": "ishan2003bhat@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/eb/b7/894c767c660542c530237f1325b58dff08697f9574ccb506ece3888a46ba/weathora-0.0.3.tar.gz",
    "platform": null,
    "description": "# Weathora <!-- omit in toc -->\n\nA simple Python CLI tool to fetch live weather data from any city using the OpenWeather API.\n\n[![PyPI version](https://img.shields.io/pypi/v/weathora.svg?color=blue)](https://pypi.org/project/weathora/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/weathora.svg)](https://pypi.org/project/weathora/)\n[![License](https://img.shields.io/github/license/bhatishan2003/asciigenator)](LICENSE)\n[![CI](https://github.com/bhatishan2003/weathora/actions/workflows/python-app.yml/badge.svg)](https://github.com/bhatishan2003/weathora/actions/workflows/python-app.yml)\n[![Build and Deploy Sphinx Docs](https://github.com/bhatishan2003/weathora/actions/workflows/sphinx.yml/badge.svg)](https://github.com/bhatishan2003/weathora/actions/workflows/sphinx.yml)\n\n## Table of Contents <!-- omit in toc -->\n\n-   [Installation](#installation)\n    -   [Create and activate a virtual environment:](#create-and-activate-a-virtual-environment)\n-   [Setup API Key \ud83d\udd11](#setup-api-key-)\n    -   [Step 1: Create an Account](#step-1-create-an-account)\n    -   [Step 2: Get Your API Key](#step-2-get-your-api-key)\n    -   [Step 3: Store the API Key](#step-3-store-the-api-key)\n        -   [\ud83d\udd39 PowerShell](#-powershell)\n        -   [\ud83d\udd39Bash](#bash)\n-   [Usage](#usage)\n    -   [Command Line Usage](#command-line-usage)\n\n---\n\n## Installation\n\n-   From pip\n\n    ```bash\n    pip install weathora\n    ```\n\n-   Clone the repository:\n\n    ```bash\n    git clone https://github.com/bhatishan2003/weathora\n    cd weathora\n    ```\n\n### Create and activate a virtual environment:\n\n1. **Create a Virtual Environment [Optional, but recommended]**\n\n    Run the following command to create a [virtual environment](https://docs.python.org/3/library/venv.html):\n\n    ```bash\n    python3 -m venv .venv\n    ```\n\n-   **Activate:**\n\n    -   **Windows (PowerShell):**\n\n        ```bash\n        .venv\\Scripts\\activate\n        ```\n\n    -   **Linux/Mac (Bash):**\n\n        ```bash\n        source .venv/bin/activate\n        ```\n\n-   **Deactivate:**\n\n    ```bash\n    deactivate\n    ```\n\n-   **Install the package:**\n\n    ```bash\n    pip install .\n    ```\n\n-   **For development (editable mode):**\n\n    ```bash\n    pip install -e .\n    ```\n\n## Setup API Key \ud83d\udd11\n\nTo use this project, you\u2019ll need an API key from **OpenWeather**.\n\n### Step 1: Create an Account\n\n1. Go to [OpenWeather API](https://home.openweathermap.org/).\n2. Sign up (or log in if you already have an account).\n\n### Step 2: Get Your API Key\n\n1. Navigate to your **API Keys** section in the OpenWeather dashboard.\n2. Copy your **API Key**.\n\n### Step 3: Store the API Key\n\nDepending on your shell, use one of the following commands:\n\n#### \ud83d\udd39 PowerShell\n\n```powershell\n$Env:OPENWEATHER_API_KEY = \"YOUR_SECRET_KEY\"\n```\n\n#### \ud83d\udd39Bash\n\n```bash\nexport OPENWEATHER_API_KEY=\"YOUR_SECRET_KEY\"\n```\n\n## Usage\n\n### Command Line Usage\n\n-   Following commands should be entered to get weather information.\n\n    ```powershell\n    weathora --city \"Delhi\"\n    weathora --city \"London\"\n    weathora --city \"Jammu\"\n    ```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python CLI tool to fetch live weather data using OpenWeather API",
    "version": "0.0.3",
    "project_urls": null,
    "split_keywords": [
        "weather",
        "cli",
        "python-cli"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c37d44d3883c3ca5fb6b87ea34245bcdff73426387b3004e5e7dd4866c5bad88",
                "md5": "e7b3ed49f76b94026ff421a90710ef66",
                "sha256": "bc1bd17453d63e9843ec43d96cc534dabb5def3cc871afa2a2eebf6e5a0d466a"
            },
            "downloads": -1,
            "filename": "weathora-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7b3ed49f76b94026ff421a90710ef66",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 5383,
            "upload_time": "2025-09-10T07:52:09",
            "upload_time_iso_8601": "2025-09-10T07:52:09.235574Z",
            "url": "https://files.pythonhosted.org/packages/c3/7d/44d3883c3ca5fb6b87ea34245bcdff73426387b3004e5e7dd4866c5bad88/weathora-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ebb7894c767c660542c530237f1325b58dff08697f9574ccb506ece3888a46ba",
                "md5": "859ec72159b4d7116a340572709e532c",
                "sha256": "d57a09370473feec5be669cf12073cb2069310f20727b43bfae4d7e93f85eba5"
            },
            "downloads": -1,
            "filename": "weathora-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "859ec72159b4d7116a340572709e532c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 6130,
            "upload_time": "2025-09-10T07:52:10",
            "upload_time_iso_8601": "2025-09-10T07:52:10.310146Z",
            "url": "https://files.pythonhosted.org/packages/eb/b7/894c767c660542c530237f1325b58dff08697f9574ccb506ece3888a46ba/weathora-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-10 07:52:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "weathora"
}
        
Elapsed time: 0.93585s