Add README and LICENSE and requirements files

Author: Mahdi-Meyghani

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mahdi-Meyghani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,64 @@
+# Weather Data REST API
+
+This Python application provides historical weather data from various stations across Europe. It is built using the Flask framework and offers a REST API for users to access weather information.
+
+## Features
+
+1. **Webpage Documentation:**
+ - The app includes a main webpage in HTML that explains how it works.
+ - Users can visit this page to understand the app's functionality and usage.
+ - This page displays the names of available stations.
+
+2. **Data Retrieval via URL:**
+ - Users can search for weather data by station number using the app's URL.
+ - If a user enters a specific station number, the REST API will return all available data (including temperature) for that station.
+
+3. **Search by Year:**
+ - Users can also search for weather data by specifying both the station number and a particular year.
+ - The REST API will provide data for that station during the specified year.
+
+4. **Specific Date Search:**
+ - For more granular queries, users can search for a specific date along with the station number.
+ - The REST API will return the temperature that particular day.
+
+## Installation
+
+1. Clone this repository to your local machine:
+ ```
+ git clone https://github.com/mahdi-meyghani/Historical-Weather-Data-API.git
+ ```
+
+2. Install the required dependencies using the `requirements.txt` file:
+ ```
+ pip install -r requirements.txt
+ ```
+
+3. Run the app:
+ ```
+ python main.py
+ ```
+
+## Usage
+
+1. Access the main webpage to learn about the app's features and how to use it.
+
+2. To retrieve weather data:
+ - Use the following URL format: `http://localhost:5000/api/v1/{station_number}/{date}` 
+ - Or `http://localhost:5000/api/v1/yearly/{station_number}/{year}`
+ - Or `http://localhost:5000/api/v1/{station_number}`
+ - Replace `{station_number}`, `{year}`, and `{date}` with the desired values.
+ - Example: `http://localhost:5000/api/v1/24/1874-10-08`
+
+3. The API will return data in JSON format, including temperature and other relevant information.
+
+## Contributing
+
+Contributions are welcome! If you find any issues or have suggestions, feel free to create a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Remember to replace placeholders like `{station_number}`, `{year}`, and `{date}` with actual values relevant to your app. Happy coding! 🌦️🌡️🌤️

requirements.txt

@@ -0,0 +1,19 @@
+blinker==1.8.2
+certifi==2024.2.2
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+Flask==3.0.3
+idna==3.7
+itsdangerous==2.2.0
+Jinja2==3.1.4
+MarkupSafe==2.1.5
+numpy==1.26.4
+pandas==2.2.2
+python-dateutil==2.9.0.post0
+pytz==2024.1
+requests==2.31.0
+six==1.16.0
+tzdata==2024.1
+urllib3==2.2.1
+Werkzeug==3.0.3