diff options
Diffstat (limited to 'python-aioflo.spec')
| -rw-r--r-- | python-aioflo.spec | 592 |
1 files changed, 592 insertions, 0 deletions
diff --git a/python-aioflo.spec b/python-aioflo.spec new file mode 100644 index 0000000..2763d46 --- /dev/null +++ b/python-aioflo.spec @@ -0,0 +1,592 @@ +%global _empty_manifest_terminate_build 0 +Name: python-aioflo +Version: 2021.11.0 +Release: 1 +Summary: A Python3, async-friendly library for Flo by Moen Smart Water Detectors +License: MIT +URL: https://github.com/bachya/aioflo +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/63/0c/0151056239383c7374d0be0cb63842dcc0dc93919d6c4e86916847dffa45/aioflo-2021.11.0.tar.gz +BuildArch: noarch + +Requires: python3-aiohttp + +%description +# 💧 aioflo: a Python3, asyncio-friendly library for Flo Smart Water Detectors + +[](https://github.com/bachya/aioflo/actions) +[](https://pypi.python.org/pypi/aioflo) +[](https://pypi.python.org/pypi/aioflo) +[](https://github.com/bachya/aioflo/blob/master/LICENSE) +[](https://codecov.io/gh/bachya/aioflo) +[](https://codeclimate.com/github/bachya/aioflo/maintainability) +[](https://saythanks.io/to/bachya) + +`aioflo` is a Python 3, `asyncio`-friendly library for interacting with +[Flo by Moen Smart Water Detectors](https://www.moen.com/flo). + +# Python Versions + +`aioflo` is currently supported on: + +* Python 3.6 +* Python 3.7 +* Python 3.8 +* Python 3.9 +* Python 3.10 + +# Installation + +```python +pip install aioflo +``` + +# Usage + +```python +import asyncio + +from aiohttp import ClientSession + +from aioflo import async_get_api + + +async def main() -> None: + """Run!""" + api = await async_get_api("<EMAIL>", "<PASSWORD>") + + # Get user account information: + user_info = await api.user.get_info() + a_location_id = user_info["locations"][0]["id"] + + # Get location (i.e., device) information: + location_info = await api.location.get_info(a_location_id) + + # Get device information + first_device_id = location_info["devices"][0]["id"] + device_info = await api.device.get_info(first_device_id) + + # Run a health test + health_test_response = await api.device.run_health_test(first_device_id) + + # Close the shutoff valve + close_valve_response = await api.device.close_valve(first_device_id) + + # Open the shutoff valve + open_valve_response = await api.device.open_valve(first_device_id) + + # Get consumption info between a start and end datetime: + consumption_info = await api.water.get_consumption_info( + a_location_id, + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Get various other metrics related to water usage: + metrics = await api.water.get_metrics( + "<DEVICE_MAC_ADDRESS>", + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Set the device in "Away" mode: + await set_mode_away(a_location_id) + + # Set the device in "Home" mode: + await set_mode_home(a_location_id) + + # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode: + await set_mode_sleep(a_location_id, 120, "away") + + +asyncio.run(main()) +``` + +By default, the library creates a new connection to Flo with each coroutine. If you are +calling a large number of coroutines (or merely want to squeeze out every second of +runtime savings possible), an +[`aiohttp`](https://github.com/aio-libs/aiohttp) `ClientSession` can be used for connection +pooling: + +```python +import asyncio + +from aiohttp import ClientSession + +from aioflo import async_get_api + + +async def main() -> None: + """Create the aiohttp session and run the example.""" + async with ClientSession() as websession: + api = await async_get_api("<EMAIL>", "<PASSWORD>", session=session) + + # Tell Flo to get updated data from the device + ping_response = await api.presence.ping() + + # Get user account information: + user_info = await api.user.get_info() + a_location_id = user_info["locations"][0]["id"] + + # Get location (i.e., device) information: + location_info = await api.location.get_info(a_location_id) + + # Get device information + first_device_id = location_info["devices"][0]["id"] + device_info = await api.device.get_info(first_device_id) + + # Run a health test + health_test_response = await api.device.run_health_test(first_device_id) + + # Close the shutoff valve + close_valve_response = await api.device.close_valve(first_device_id) + + # Open the shutoff valve + open_valve_response = await api.device.open_valve(first_device_id) + + # Get consumption info between a start and end datetime: + consumption_info = await api.water.get_consumption_info( + a_location_id, + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Get various other metrics related to water usage: + metrics = await api.water.get_metrics( + "<DEVICE_MAC_ADDRESS>", + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Set the device in "Away" mode: + await set_mode_away(a_location_id) + + # Set the device in "Home" mode: + await set_mode_home(a_location_id) + + # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode: + await set_mode_sleep(a_location_id, 120, "away") + + +asyncio.run(main()) +``` + +# Contributing + +1. [Check for open features/bugs](https://github.com/bachya/aioflo/issues) + or [initiate a discussion on one](https://github.com/bachya/aioflo/issues/new). +2. [Fork the repository](https://github.com/bachya/aioflo/fork). +3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv` +4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate` +5. Install the dev environment: `script/setup` +6. Code your new feature or bug fix. +7. Write tests that cover your new functionality. +8. Run tests and ensure 100% code coverage: `script/test` +9. Update `README.md` with any new documentation. +10. Add yourself to `AUTHORS.md`. +11. Submit a pull request! + + +%package -n python3-aioflo +Summary: A Python3, async-friendly library for Flo by Moen Smart Water Detectors +Provides: python-aioflo +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-aioflo +# 💧 aioflo: a Python3, asyncio-friendly library for Flo Smart Water Detectors + +[](https://github.com/bachya/aioflo/actions) +[](https://pypi.python.org/pypi/aioflo) +[](https://pypi.python.org/pypi/aioflo) +[](https://github.com/bachya/aioflo/blob/master/LICENSE) +[](https://codecov.io/gh/bachya/aioflo) +[](https://codeclimate.com/github/bachya/aioflo/maintainability) +[](https://saythanks.io/to/bachya) + +`aioflo` is a Python 3, `asyncio`-friendly library for interacting with +[Flo by Moen Smart Water Detectors](https://www.moen.com/flo). + +# Python Versions + +`aioflo` is currently supported on: + +* Python 3.6 +* Python 3.7 +* Python 3.8 +* Python 3.9 +* Python 3.10 + +# Installation + +```python +pip install aioflo +``` + +# Usage + +```python +import asyncio + +from aiohttp import ClientSession + +from aioflo import async_get_api + + +async def main() -> None: + """Run!""" + api = await async_get_api("<EMAIL>", "<PASSWORD>") + + # Get user account information: + user_info = await api.user.get_info() + a_location_id = user_info["locations"][0]["id"] + + # Get location (i.e., device) information: + location_info = await api.location.get_info(a_location_id) + + # Get device information + first_device_id = location_info["devices"][0]["id"] + device_info = await api.device.get_info(first_device_id) + + # Run a health test + health_test_response = await api.device.run_health_test(first_device_id) + + # Close the shutoff valve + close_valve_response = await api.device.close_valve(first_device_id) + + # Open the shutoff valve + open_valve_response = await api.device.open_valve(first_device_id) + + # Get consumption info between a start and end datetime: + consumption_info = await api.water.get_consumption_info( + a_location_id, + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Get various other metrics related to water usage: + metrics = await api.water.get_metrics( + "<DEVICE_MAC_ADDRESS>", + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Set the device in "Away" mode: + await set_mode_away(a_location_id) + + # Set the device in "Home" mode: + await set_mode_home(a_location_id) + + # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode: + await set_mode_sleep(a_location_id, 120, "away") + + +asyncio.run(main()) +``` + +By default, the library creates a new connection to Flo with each coroutine. If you are +calling a large number of coroutines (or merely want to squeeze out every second of +runtime savings possible), an +[`aiohttp`](https://github.com/aio-libs/aiohttp) `ClientSession` can be used for connection +pooling: + +```python +import asyncio + +from aiohttp import ClientSession + +from aioflo import async_get_api + + +async def main() -> None: + """Create the aiohttp session and run the example.""" + async with ClientSession() as websession: + api = await async_get_api("<EMAIL>", "<PASSWORD>", session=session) + + # Tell Flo to get updated data from the device + ping_response = await api.presence.ping() + + # Get user account information: + user_info = await api.user.get_info() + a_location_id = user_info["locations"][0]["id"] + + # Get location (i.e., device) information: + location_info = await api.location.get_info(a_location_id) + + # Get device information + first_device_id = location_info["devices"][0]["id"] + device_info = await api.device.get_info(first_device_id) + + # Run a health test + health_test_response = await api.device.run_health_test(first_device_id) + + # Close the shutoff valve + close_valve_response = await api.device.close_valve(first_device_id) + + # Open the shutoff valve + open_valve_response = await api.device.open_valve(first_device_id) + + # Get consumption info between a start and end datetime: + consumption_info = await api.water.get_consumption_info( + a_location_id, + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Get various other metrics related to water usage: + metrics = await api.water.get_metrics( + "<DEVICE_MAC_ADDRESS>", + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Set the device in "Away" mode: + await set_mode_away(a_location_id) + + # Set the device in "Home" mode: + await set_mode_home(a_location_id) + + # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode: + await set_mode_sleep(a_location_id, 120, "away") + + +asyncio.run(main()) +``` + +# Contributing + +1. [Check for open features/bugs](https://github.com/bachya/aioflo/issues) + or [initiate a discussion on one](https://github.com/bachya/aioflo/issues/new). +2. [Fork the repository](https://github.com/bachya/aioflo/fork). +3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv` +4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate` +5. Install the dev environment: `script/setup` +6. Code your new feature or bug fix. +7. Write tests that cover your new functionality. +8. Run tests and ensure 100% code coverage: `script/test` +9. Update `README.md` with any new documentation. +10. Add yourself to `AUTHORS.md`. +11. Submit a pull request! + + +%package help +Summary: Development documents and examples for aioflo +Provides: python3-aioflo-doc +%description help +# 💧 aioflo: a Python3, asyncio-friendly library for Flo Smart Water Detectors + +[](https://github.com/bachya/aioflo/actions) +[](https://pypi.python.org/pypi/aioflo) +[](https://pypi.python.org/pypi/aioflo) +[](https://github.com/bachya/aioflo/blob/master/LICENSE) +[](https://codecov.io/gh/bachya/aioflo) +[](https://codeclimate.com/github/bachya/aioflo/maintainability) +[](https://saythanks.io/to/bachya) + +`aioflo` is a Python 3, `asyncio`-friendly library for interacting with +[Flo by Moen Smart Water Detectors](https://www.moen.com/flo). + +# Python Versions + +`aioflo` is currently supported on: + +* Python 3.6 +* Python 3.7 +* Python 3.8 +* Python 3.9 +* Python 3.10 + +# Installation + +```python +pip install aioflo +``` + +# Usage + +```python +import asyncio + +from aiohttp import ClientSession + +from aioflo import async_get_api + + +async def main() -> None: + """Run!""" + api = await async_get_api("<EMAIL>", "<PASSWORD>") + + # Get user account information: + user_info = await api.user.get_info() + a_location_id = user_info["locations"][0]["id"] + + # Get location (i.e., device) information: + location_info = await api.location.get_info(a_location_id) + + # Get device information + first_device_id = location_info["devices"][0]["id"] + device_info = await api.device.get_info(first_device_id) + + # Run a health test + health_test_response = await api.device.run_health_test(first_device_id) + + # Close the shutoff valve + close_valve_response = await api.device.close_valve(first_device_id) + + # Open the shutoff valve + open_valve_response = await api.device.open_valve(first_device_id) + + # Get consumption info between a start and end datetime: + consumption_info = await api.water.get_consumption_info( + a_location_id, + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Get various other metrics related to water usage: + metrics = await api.water.get_metrics( + "<DEVICE_MAC_ADDRESS>", + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Set the device in "Away" mode: + await set_mode_away(a_location_id) + + # Set the device in "Home" mode: + await set_mode_home(a_location_id) + + # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode: + await set_mode_sleep(a_location_id, 120, "away") + + +asyncio.run(main()) +``` + +By default, the library creates a new connection to Flo with each coroutine. If you are +calling a large number of coroutines (or merely want to squeeze out every second of +runtime savings possible), an +[`aiohttp`](https://github.com/aio-libs/aiohttp) `ClientSession` can be used for connection +pooling: + +```python +import asyncio + +from aiohttp import ClientSession + +from aioflo import async_get_api + + +async def main() -> None: + """Create the aiohttp session and run the example.""" + async with ClientSession() as websession: + api = await async_get_api("<EMAIL>", "<PASSWORD>", session=session) + + # Tell Flo to get updated data from the device + ping_response = await api.presence.ping() + + # Get user account information: + user_info = await api.user.get_info() + a_location_id = user_info["locations"][0]["id"] + + # Get location (i.e., device) information: + location_info = await api.location.get_info(a_location_id) + + # Get device information + first_device_id = location_info["devices"][0]["id"] + device_info = await api.device.get_info(first_device_id) + + # Run a health test + health_test_response = await api.device.run_health_test(first_device_id) + + # Close the shutoff valve + close_valve_response = await api.device.close_valve(first_device_id) + + # Open the shutoff valve + open_valve_response = await api.device.open_valve(first_device_id) + + # Get consumption info between a start and end datetime: + consumption_info = await api.water.get_consumption_info( + a_location_id, + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Get various other metrics related to water usage: + metrics = await api.water.get_metrics( + "<DEVICE_MAC_ADDRESS>", + datetime(2020, 1, 16, 0, 0), + datetime(2020, 1, 16, 23, 59, 59, 999000), + ) + + # Set the device in "Away" mode: + await set_mode_away(a_location_id) + + # Set the device in "Home" mode: + await set_mode_home(a_location_id) + + # Set the device in "Sleep" mode for 120 minutes, then return to "Away" mode: + await set_mode_sleep(a_location_id, 120, "away") + + +asyncio.run(main()) +``` + +# Contributing + +1. [Check for open features/bugs](https://github.com/bachya/aioflo/issues) + or [initiate a discussion on one](https://github.com/bachya/aioflo/issues/new). +2. [Fork the repository](https://github.com/bachya/aioflo/fork). +3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv` +4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate` +5. Install the dev environment: `script/setup` +6. Code your new feature or bug fix. +7. Write tests that cover your new functionality. +8. Run tests and ensure 100% code coverage: `script/test` +9. Update `README.md` with any new documentation. +10. Add yourself to `AUTHORS.md`. +11. Submit a pull request! + + +%prep +%autosetup -n aioflo-2021.11.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-aioflo -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Mar 07 2023 Python_Bot <Python_Bot@openeuler.org> - 2021.11.0-1 +- Package Spec generated |