Python utilities for working with platon ABI definitions, especially encoding and decoding
Read more in the documentation on ReadTheDocs. View the change log.
pip install platon_abiIf you would like to hack on platon-abi, please check out the Snake Charmers Tactical Manual for information on how we do:
- Testing
- Pull Requests
- Code Style
- Documentation
You can set up your dev environment with:
git clone git@github.com:platon/platon-abi.git
cd platon-abi
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]During development, you might like to have tests run on every file save.
Show flake8 errors on file change:
# Test flake8
when-changed -v -s -r -1 platon_abi/ tests/ -c "clear; flake8 platon_abi tests && echo 'flake8 success' || echo 'error'"Run multi-process tests in one command, but without color:
# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1Run in one thread, with color and desktop notifications:
cd venv
ptw --onfail "notify-send -t 5000 'Test failure' 'python 3 test on platon-abi failed'" ../tests ../platon_abiFor Debian-like systems:
apt install pandoc
To release a new version:
make release bump=$$VERSION_PART_TO_BUMP$$The version format for this repo is {major}.{minor}.{patch} for stable, and
{major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).
To issue the next version in line, specify which part to bump,
like make release bump=minor or make release bump=devnum. This is typically done from the
master branch, except when releasing a beta (in which case the beta is released from master,
and the previous stable branch is released from said branch).
If you are in a beta version, make release bump=stage will switch to a stable.
To issue an unstable version when the current version is stable, specify the
new version explicitly, like make release bump="--new-version 4.0.0-alpha.1 devnum"