基本远程IO应用程序
trimarlib-brio的Python项目详细描述
trimarlib brio
basic远程输入/输出-python应用程序
开始
这些说明将在本地计算机上为您获取项目的副本,以便进行开发和测试。 有关如何在活动系统上部署项目的说明,请参见Deployment。
先决条件
构建过程需要一些基本的开发工具:
make
-gnu make程序,用于*nix或windows系统,用于执行生成和测试目标git
-不仅用于克隆存储库,还用于自动版本控制(请参见Versioning)python3
两个标准的python包用于构建和安装步骤:
setuptools
wheel
应用程序依赖于以下库:
trimarlib-sysfsgpio
trimarlib-newland
json-rpc
这些依赖项在setup.py
安装脚本中定义,因此应该
由pip
自动满足。
建造和释放
调用make all
(默认目标)准备分发存档。它分两步完成:
- 查询git存储库中的标记(
git describe
命令)以确定当前版本并生成version.py
文件, - 调用传递
setup.py
脚本的python解释器来准备源代码和轮子分发。
由Makefile
调用的python解释器默认为python
-可以重写它
向命令传递PYTHON
变量,例如make all PYTHON=python3
。
发布过程是自动化的,并且基于gitlab ci/cd环境-每个提交都会触发一个构建作业 它尝试生成和安装生成的包。如果已标记提交,则生成的控制盘分布 传递到部署阶段,运行程序尝试将包上载到存储库 在项目设置中指定。
部署
通过pip
(即pip install trimarlib-brio
)安装是推荐的部署方法。
安装软件包后,建议执行其他步骤:
- 安装
gpio-exporter.service
和gpio.rules
-请参阅 ^{} project 了解更多信息; - 安装
brio.service
和brio.ini
配置文件。
第二步使用软件包提供的入口点执行:
brio-install-service
-将预定义的服务文件复制到/etc/systemd/system/brio.service
,重新加载systemd
守护进程并启用服务。运行brio-install-service -h
获取更多信息;brio-install-configuration
-将默认配置文件复制到默认位置。 运行brio-install-configuration -h
获取更多信息。brio-install
-一次性执行上述步骤。运行brio-install -h
获取更多信息。
应用程序是使用另一个入口点-brio-app
启动的。运行brio-app -h
获取更多信息。
版本控制
该项目使用基于存储库标记功能的简单模式进行版本控制。见Makefile 有关实现的详细信息,有关可用版本,请参见 tags on this repository。
使用量
有关API文档,请参阅docstrings。
在自定义应用程序中使用服务器的示例:
frombrioimportServerimporttimeserver=Server()server.configure()server.start()time.sleep(10)server.stop()
应用程序使用brio-app
入口点运行,有关详细信息,请参见Deployment。
许可证
这个软件是在麻省理工学院的许可下授权的-参见LICENSE。
相关文件
此软件符合json-rpc协议,有关详细信息,请参见website。