Skip to content

Commit 134a24b

Browse files
committed
modified the README
1 parent 1dfea5e commit 134a24b

File tree

1 file changed

+2
-37
lines changed

1 file changed

+2
-37
lines changed

weather_notifier/README.md

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1-
21
# Weather Notifier - README
32

43
## Overview
54
The **Weather Notifier** is a Python-based GUI application built with `Tkinter`, which allows users to retrieve weather information for any city using the OpenWeatherMap API. It provides two modes of operation:
65
- **Manual Mode**: Fetch the weather on-demand with a single click.
7-
- **Auto Mode**: Fetch the weather at regular intervals and can also run in background.
6+
- **Auto Mode**: Fetch the weather at regular intervals and can also run in the background.
87

98
The app displays current weather details such as temperature, humidity, wind speed, and more in a user-friendly interface.
109

1110
## Features
1211
- Fetch current weather for any city globally.
1312
- Switch between manual and automatic weather updates.
1413
- Display detailed weather information, including temperature, humidity, wind, and more.
15-
- Adjustable update interval when in auto mode.
1614
- Option to stop the automatic weather updates and return to the main city selection screen.
1715

1816
## Prerequisites
@@ -25,43 +23,10 @@ The app displays current weather details such as temperature, humidity, wind spe
2523
- `dotenv`
2624

2725
To install the required libraries, use the following command:
28-
```bash or windows
26+
```bash
2927
pip install -r requirements.txt
3028
```
3129

32-
## Installation and Setup
33-
1. Clone the repository or download the script.
34-
2. Set up a `.env` file in the same directory as the script, and add your OpenWeatherMap API key like so:
35-
```env
36-
OPENWEATHER_API_KEY=your_api_key_here
37-
```
38-
3. Run the script:
39-
```bash
40-
python weather_notifier.py
41-
```
42-
43-
## Usage
44-
1. **City Entry**:
45-
- Enter the name of the city for which you want to fetch the weather.
46-
47-
2. **Mode Selection**:
48-
- **Manual Mode**: Select "On-click only" to get weather updates with a button press.
49-
- **Auto Mode**: Select "Run after a fixed interval" and input an interval in seconds to get weather updates automatically at the specified interval.
50-
51-
3. **Start Notifier**:
52-
- Click the `Start Notifier` button to begin fetching weather updates.
53-
54-
4. **Stop Notifier**:
55-
- If you are in auto mode, click the `Stop Notifier` button to stop automatic updates and return to the city selection screen.
56-
57-
## Example
58-
- In manual mode, you simply input your city name and press the `Start Notifier` button to get weather information.
59-
- In auto mode, you can set an interval (e.g., 10 seconds) to fetch updates regularly, which will continue until the `Stop Notifier` button is pressed.
60-
61-
## Notes
62-
- Ensure you have a valid OpenWeatherMap API key in your `.env` file.
63-
- The app defaults to "On-click only" mode if no mode is selected.
64-
6530
## Screenshots
6631
![Main Screen](./images/box.jpg)
6732
![Error](./images/error_box.jpg)

0 commit comments

Comments
 (0)