Weather App

🚀 Weather Application

A command-line and MCP (MindSpire Command Protocol) based weather application that provides current weather conditions, forecasts, and alert information for any location worldwide.

✨ Features

• Get current weather conditions for any location.
• Get daily weather forecasts.
• Get hourly weather forecasts.
• Get weather alerts.
• Get weather by coordinates.
• Automatic location detection.
• Test API connection status.
• Check API key and subscription information.

📦 Installation

Prerequisites

• Python 3.12 or higher.
• uv package manager.

Installation Steps

1. Clone this repository:

   git clone <repository-url>
   cd weather-app
   

2. Create a .env file in the root directory and add your OpenWeatherMap API key:

   OPENWEATHER_API_KEY=your_api_key_here
   

   You can obtain an API key from OpenWeatherMap.
3. Run the installation script:

   ./scripts/install.sh
   

   For the development environment, use:

   ./scripts/install.sh --dev
   

💻 Usage Examples

Basic Usage

Run the weather application:

./scripts/run_weather.sh

This will start the MCP server, providing the following available tools:

• get_current_weather: Get current weather conditions.
• get_forecast: Get daily weather forecasts.
• get_hourly_forecast: Get hourly weather forecasts.
• get_alerts: Get weather alerts.
• get_weather_by_coordinates: Get weather by coordinates.
• get_user_location: Get your current location.
• test_api_connection: Test API connection status.
• check_api_key_and_subscription: Check API key and subscription information.

📚 Documentation

Code Style and Linting

This project uses the following tools:

• Black for code formatting.
• isort for import sorting.
• Ruff for code checking.
• mypy for type checking. All tool configurations are in the pyproject.toml file.

Pre-commit Hooks

We use pre-commit hooks to ensure code quality. After installing the development dependencies, the hooks will be automatically set up. To manually install pre-commit hooks:

uv run pre-commit install

To manually run all hooks:

uv run pre-commit run --all-files

Testing

Run tests:

./scripts/run_tests.sh

Run tests with coverage:

./scripts/run_tests.sh --coverage

Run integration tests (API key required):

./scripts/run_tests.sh --integration

Run integration tests with coverage:

./scripts/run_tests.sh --integration --coverage

Creating an MCP Server

Use this project as a template to create your own MCP server:

1. Install the project with development dependencies:

   ./scripts/install.sh --dev
   

2. Create a new Python script and add the following content:

from mindspire_protocol import MCPProtocol

# Implement specific business logic as needed
class MyMCPServer:
    def handle_command(self, command: str) -> str:
        # Implement specific command handling logic
        pass

if __name__ == "__main__":
    server = MyMCPServer()
    mcp_protocol = MCPProtocol(server)
    mcp_protocol.start_listening()

3. Extend and implement specific business functions as needed.

📄 License

This project is licensed under the MIT License.