Portal网络工具

与Ethereum Portal网络相关的实用工具集合

在ReadTheDocs的文档中了解更多信息。 查看更改日志.

快速入门

pip install eth-portal

开发者设置

如果您想对eth-portal进行开发，请查看Snake Charmers战术手册，了解我们是如何做的

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

开发环境设置

您可以使用以下方法设置您的开发环境

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

测试设置

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

在文件更改时显示flake8错误

# Test flake8
when-changed -v -s -r -1 eth_portal/ tests/ -c "clear; flake8 eth_portal 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 eth-portal failed'" ../tests ../eth_portal

发布设置

对于类似Debian的系统

apt install pandoc

要发布新版本

make release bump=$$VERSION_PART_TO_BUMP$$

如何使用bumpversion

该存储库的版本格式为稳定版为{major}.{minor}.{patch}，不稳定版为{major}.{minor}.{patch}-{stage}.{devnum}（stage可以是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"