Skip to content

Commit

Permalink
chore: add some information in the readme (#7)
Browse files Browse the repository at this point in the history
add some information in the readme
  • Loading branch information
lhw authored Jun 9, 2024
1 parent 0bd95e2 commit fc316c2
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
51 changes: 49 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,52 @@
# aiocloudweather

Simple python library for parsing Wundergrund and Weathercloud update requests
[![PyPI Release][pypi]][pypi-page]
[![GitHub Activity][commits-shield]][commits]
[![Project Maintenance][maintenance-shield]][maintainer]
[![Mastodon][mastodon]][mastodon_profile]

Based on aioecowitt

A simple Python library for parsing Wunderground and Weathercloud update requests, based on aioecowitt for Ecowitt weather stations.

## Installation

You can install `aiocloudweather` from PyPI using pip:

```shell
pip install aiocloudweather
```

## Usage

```python
import asyncio
import aiocloudweather

async def dataset_handler(station: WeatherStation):
# Your code here


app = CloudWeatherListener()
app.new_dataset_cb.append(dataset_handler)

await app.start()
while True:
await asyncio.sleep(100000)

```

## Contributing

Contributions are welcome! Please also check the [Cloud Weather Proxy][cloudweatherproxy] project which uses this library to enable the weather stations in HomeAssistant.



[pypi]: https://img.shields.io/pypi/v/aiocloudweather
[pypi-page]: https://pypi.org/project/aiocloudweather/
[commits-shield]: https://img.shields.io/github/commit-activity/y/lhw/cloudweatherproxy.svg
[commits]: https://github.com/lhw/cloudweatherproxy/commits/main
[maintenance-shield]: https://img.shields.io/badge/maintainer-Lennart%20Weller%20%40lhw-blue.svg
[maintainer]: https://github.com/lhw
[mastodon]: https://img.shields.io/mastodon/follow/000048422?domain=https%3A%2F%2Fchaos.social
[mastodon_profile]: https://chaos.social/@lhw
[cloudweatherproxy]: https://github.com/lhw/cloudweatherproxy
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
package_data={"aiocoudweather": ["py.typed"]},
python_requires=">=3.12",
install_requires=["aiohttp>3", "aiodns>3"],
license_files=["LICENSE"],
entry_points={
"console_scripts": ["cloudweather-testserver = aiocloudweather.__main__:main"]
},
Expand Down

0 comments on commit fc316c2

Please sign in to comment.