aioemonitor

Asyncio Python库用于SiteSage Emonitor

特性

• 检索emonitor电源状态

快速入门

import asyncio
import pprint
from aioemonitor import Emonitor
from aiohttp import ClientSession

async def run():
    session = ClientSession()
    emonitor = Emonitor("1.2.3.4", session)
    status = await emonitor.async_get_status()
    pprint.pprint(status)

asyncio.run(run())

安装

稳定版本： pip install aioemonitor
开发头部： pip install git+https://github.com/bdraco/aioemonitor.git

文档

有关完整包文档，请访问 bdraco.github.io/aioemonitor。

开发

请参阅 CONTRIBUTING.md 了解有关代码开发的信息。

您需要知道的四个命令

1. pip install -e .[dev]

   这将以可编辑模式安装您的软件包，并包含所有必需的开发依赖项（即 tox）。

2. make build

   这将运行 tox，它将在Python 3.7和Python 3.8上运行所有测试，并对您的代码进行linting。

3. make clean

   这将清理各种Python和构建生成的文件，以确保您在一个干净的环境中工作。

4. make docs

   这将生成并启动一个网络浏览器，以查看您Python包的最新文档。

其他可选设置步骤

• 将您的项目转换为GitHub仓库
  • 在 github.com 上创建账户
  • 转到 创建新仓库
  • 建议
    • 强烈建议将仓库名称与Python包名称相同
    • 如果仓库是公开的，以下许多可选步骤都是免费的，开源也是很酷的
  • 在GitHub仓库创建后，运行以下命令中的命令： "...或者从命令行推送现有的仓库"
• 在Codecov上注册您的项目
  • 在codecov.io上创建账户（建议使用GitHub登录）其他所有事情都将为您处理。
• 确保您已经将GitHub Pages设置为构建gh-pages分支，通过在仓库设置的“GitHub Pages”部分的下拉菜单中选择gh-pages分支。(仓库设置)
• 在PyPI上注册您的项目
  • 在pypi.org上创建账户
  • 转到您的GitHub仓库设置，在“Secrets”标签页下，添加一个名为PYPI_TOKEN的秘密，使用您的PyPI账户密码。不用担心，没有人会看到这个密码，因为它将被加密。
  • 下次您使用bump2version后推送至main分支，GitHub Actions将构建并将您的Python包部署到PyPI。

建议的Git分支策略

1. main用于最新的开发，您很少应该直接提交到这个分支。GitHub Actions将在每次推送和对此分支的CRON运行时执行，但仍建议您提交到您的开发分支，并将拉取请求发送到main。如果您使用bumpversion推送带标签的提交，这将也会发布到PyPI。
2. 您日常的工作应该在main之外的分支上进行。即使只有您一个人在仓库上工作，也请从您的开发分支向main发起PR，以确保您的提交不会破坏开发头。GitHub Actions将在推送任何分支或从任何分支向任何其他分支的任何PR时运行。
3. 建议在提交PR时使用“Squash and Merge”提交。它使每组对main的更改都变为原子操作，并且作为一个副作用，自然会鼓励创建小的、定义明确的PR。

Apache软件许可证2.0