# PlatON Utilities
[](https://gitter.im/platon/platon-utils?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://circleci.com/gh/platon/platon-utils)
[](https://badge.fury.io/py/platon-utils)
[](https://pypi.python.org/pypi/platon-utils)
[](http://platon-utils.readthedocs.io/en/latest/?badge=latest)
Common utility functions for python code that interacts with PlatON
Read more in the [documentation on ReadTheDocs](https://platon-utils.readthedocs.io/). [View the change log](https://platon-utils.readthedocs.io/en/latest/release_notes.html).
## Quickstart
```sh
pip install platon-utils
```
## Developer Setup
If you would like to hack on platon-utils, please check out the [Snake Charmers
Tactical Manual](https://github.com/platon/snake-charmers-tactical-manual)
for information on how we do:
- Testing
- Pull Requests
- Code Style
- Documentation
### Development Environment Setup
You can set up your dev environment with:
```sh
git clone git@github.com:platon/platon-utils.git
cd platon-utils
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]
pip install -e platon-hash[pycryptodome]
```
### Testing Setup
During development, you might like to have tests run on every file save.
Show flake8 errors on file change:
```sh
# Test flake8
when-changed -v -s -r -1 platon_utils/ tests/ -c "clear; flake8 platon_utils tests && echo 'flake8 success' || echo 'error'"
```
Run multi-process tests in one command, but without color:
```sh
# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1
```
Run in one thread, with color and desktop notifications:
```sh
cd venv
ptw --onfail "notify-send -t 5000 'Test failure' 'python 3 test on platon-utils failed'" ../tests ../platon_utils
```
### Release setup
To release a new version:
```sh
make release bump=$$VERSION_PART_TO_BUMP$$
```
#### How to bumpversion
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"`
Raw data
{
"_id": null,
"home_page": "https://github.com/platon/platon-utils",
"name": "platon-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5,!=3.5.2,<4",
"maintainer_email": "",
"keywords": "platon",
"author": "Shinnng",
"author_email": "shinnng@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/1e/7e/a61582d8659b280198a975d0f010eab505897229d0fddff9bdf694ff0ec8/platon-utils-1.2.1.tar.gz",
"platform": null,
"description": "# PlatON Utilities\n\n[](https://gitter.im/platon/platon-utils?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://circleci.com/gh/platon/platon-utils)\n[](https://badge.fury.io/py/platon-utils)\n[](https://pypi.python.org/pypi/platon-utils)\n[](http://platon-utils.readthedocs.io/en/latest/?badge=latest)\n \n\nCommon utility functions for python code that interacts with PlatON\n\nRead more in the [documentation on ReadTheDocs](https://platon-utils.readthedocs.io/). [View the change log](https://platon-utils.readthedocs.io/en/latest/release_notes.html).\n\n## Quickstart\n\n```sh\npip install platon-utils\n```\n\n## Developer Setup\n\nIf you would like to hack on platon-utils, please check out the [Snake Charmers\nTactical Manual](https://github.com/platon/snake-charmers-tactical-manual)\nfor information on how we do:\n\n- Testing\n- Pull Requests\n- Code Style\n- Documentation\n\n### Development Environment Setup\n\nYou can set up your dev environment with:\n\n```sh\ngit clone git@github.com:platon/platon-utils.git\ncd platon-utils\nvirtualenv -p python3 venv\n. venv/bin/activate\npip install -e .[dev]\npip install -e platon-hash[pycryptodome]\n```\n\n### Testing Setup\n\nDuring development, you might like to have tests run on every file save.\n\nShow flake8 errors on file change:\n\n```sh\n# Test flake8\nwhen-changed -v -s -r -1 platon_utils/ tests/ -c \"clear; flake8 platon_utils tests && echo 'flake8 success' || echo 'error'\"\n```\n\nRun multi-process tests in one command, but without color:\n\n```sh\n# in the project root:\npytest --numprocesses=4 --looponfail --maxfail=1\n# the same thing, succinctly:\npytest -n 4 -f --maxfail=1\n```\n\nRun in one thread, with color and desktop notifications:\n\n```sh\ncd venv\nptw --onfail \"notify-send -t 5000 'Test failure' 'python 3 test on platon-utils failed'\" ../tests ../platon_utils\n```\n\n### Release setup\n\nTo release a new version:\n\n```sh\nmake release bump=$$VERSION_PART_TO_BUMP$$\n```\n\n#### How to bumpversion\n\nThe version format for this repo is `{major}.{minor}.{patch}` for stable, and\n`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).\n\nTo issue the next version in line, specify which part to bump,\nlike `make release bump=minor` or `make release bump=devnum`. This is typically done from the\nmaster branch, except when releasing a beta (in which case the beta is released from master,\nand the previous stable branch is released from said branch).\n\nIf you are in a beta version, `make release bump=stage` will switch to a stable.\n\nTo issue an unstable version when the current version is stable, specify the\nnew version explicitly, like `make release bump=\"--new-version 4.0.0-alpha.1 devnum\"`\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "platon-utils: Common utility functions for python code that interacts with PlatON",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/platon/platon-utils"
},
"split_keywords": [
"platon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f7bdd4dd09436e22400291489e12dabe5f322176b10c93f78ebb16f639647a1",
"md5": "d8370691e79b75a378c23fd1b14761e7",
"sha256": "543a11a1c6098734ae50f9902914d715864261a99d1470dd3e61e9bd3117a59b"
},
"downloads": -1,
"filename": "platon_utils-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8370691e79b75a378c23fd1b14761e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5,!=3.5.2,<4",
"size": 27124,
"upload_time": "2022-06-08T09:18:02",
"upload_time_iso_8601": "2022-06-08T09:18:02.345819Z",
"url": "https://files.pythonhosted.org/packages/7f/7b/dd4dd09436e22400291489e12dabe5f322176b10c93f78ebb16f639647a1/platon_utils-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e7ea61582d8659b280198a975d0f010eab505897229d0fddff9bdf694ff0ec8",
"md5": "ff09da2ad9072a1464c48e0aab4859a3",
"sha256": "1586a37add600ae84d89a0e79e2c72e12adf63f077ce2a162a45ac0ff0237c78"
},
"downloads": -1,
"filename": "platon-utils-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ff09da2ad9072a1464c48e0aab4859a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5,!=3.5.2,<4",
"size": 23425,
"upload_time": "2022-06-08T09:18:04",
"upload_time_iso_8601": "2022-06-08T09:18:04.643641Z",
"url": "https://files.pythonhosted.org/packages/1e/7e/a61582d8659b280198a975d0f010eab505897229d0fddff9bdf694ff0ec8/platon-utils-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-08 09:18:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "platon",
"github_project": "platon-utils",
"github_not_found": true,
"lcname": "platon-utils"
}
JSON
