Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simeononsecurity/weatherxm-python
A Script That Interfaces with WeatherXM API and Pulls Weather Information from Your Weather XM Devices
https://github.com/simeononsecurity/weatherxm-python
depin python python-script python3 weather weather-api web3 wihi
Last synced: 19 days ago
JSON representation
A Script That Interfaces with WeatherXM API and Pulls Weather Information from Your Weather XM Devices
- Host: GitHub
- URL: https://github.com/simeononsecurity/weatherxm-python
- Owner: simeononsecurity
- License: mit
- Created: 2024-03-27T08:46:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-26T22:54:13.000Z (6 months ago)
- Last Synced: 2024-11-08T20:17:53.798Z (2 months ago)
- Topics: depin, python, python-script, python3, weather, weather-api, web3, wihi
- Language: Python
- Homepage: https://simeononsecurity.com
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WeatherXM Python Integration
[](https://github.com/sponsors/simeononsecurity)
## About
This Python script facilitates interaction with the WeatherXM API, allowing users to authenticate, fetch device lists, and retrieve weather history data. It's designed to work with WeatherXM's system for users to access weather data from their registered devices.
## Features
- User authentication with the WeatherXM API.
- Fetching a list of all devices associated with the user's account.
- Retrieving detailed weather history for each device.
- Saving weather data to JSON files organized by date.
- Console output of weather data in a human-readable format.
## Getting Started
### Prerequisites
- Python 3.6 or later.
- `requests` library.
- A `.env` file with your WeatherXM credentials.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/simeononsecurity/WeatherXM-Python.git
cd WeatherXM-Python
```
2. Install the required Python libraries:
```bash
pip install -r requirements.txt
```
3. Create a `.env` file in the root directory of the project with your WeatherXM API credentials:
```plaintext
WEATHERXMUSERNAME=your_username_here
WEATHERXMPASSWORD=your_password_here
```
### Usage
Run the script with Python:
```bash
python main.py
```
The script will authenticate with the WeatherXM API, fetch the list of devices, retrieve weather data for each device, save the data to JSON files, and print a summary to the console.
## Contributing
Contributions to enhance the functionality, improve the documentation, or fix bugs are welcome. Please open an issue or submit a pull request.
## License
Distributed under the MIT License. See `LICENSE` for more information.