UPnP端口转发

为人类设计的UPnP端口转发

更多请参阅ReadTheDocs上的文档。 查看变更日志。

快速入门

pip install upnp-port-forward

开发者设置

如果您想为upnp-port-forward进行开发，请查看Snake Charmers战术手册，了解我们是如何做的。

• 测试
• 拉取请求
• 代码风格
• 文档

开发环境设置

您可以使用以下命令设置您的开发环境

git clone git@github.com:ethereum/upnp-port-forward.git
cd upnp-port-forward
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]

测试设置

在开发过程中，您可能希望在每次文件保存时运行测试。

在文件更改时显示flake8错误

# Test flake8
when-changed -v -s -r -1 upnp_port_forward/ tests/ -c "clear; flake8 upnp_port_forward tests && echo 'flake8 success' || echo 'error'"

使用一个命令运行多进程测试，但不显示颜色

# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1

在一个线程中运行，显示颜色和桌面通知

cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on upnp-port-forward failed'" ../tests ../upnp_port_forward

发布设置

对于类似Debian的系统

apt install pandoc

要发布新版本

make release bump=$$VERSION_PART_TO_BUMP$$

如何bumpversion

此存储库的版本格式为稳定版本的{major}.{minor}.{patch}，不稳定版本为{major}.{minor}.{patch}-{stage}.{devnum}（阶段可以是alpha或beta）。

要发布下一个版本，请指定要升级的部分，例如make release bump=minor或make release bump=devnum。这通常在master分支上完成，除非发布beta版本（在这种情况下，beta版本从master分支发布，而之前的稳定版本从该分支发布）。

如果您处于测试版，执行make release bump=stage将切换到稳定版。

当当前版本为稳定版时，要发布不稳定版本，请明确指定新版本，例如：make release bump="--new-version 4.0.0-alpha.1 devnum"