# platon-typing
[](https://gitter.im/platonnetwork/platon-typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://circleci.com/gh/platonnetwork/platon-typing)
[](https://badge.fury.io/py/platon-typing)
[](https://pypi.python.org/pypi/platon-typing)
[](http://platon-typing.readthedocs.io/en/latest/?badge=latest)
Common type annotations for platon python packages.
Read more in the [documentation on ReadTheDocs](https://platon-typing.readthedocs.io/). [View the change log](https://platon-typing.readthedocs.io/en/latest/releases.html).
## Quickstart
```sh
pip install platon-typing
```
## Developer Setup
If you would like to hack on platon-typing, please check out the [Snake Charmers
Tactical Manual](https://github.com/platonnetwork/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-typing.git
cd platon-typing
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]
```
### 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_typing/ tests/ -c "clear; flake8 platon_typing 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-typing failed'" ../tests ../platon_typing
```
### Release setup
For Debian-like systems:
```
apt install pandoc
```
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). To include changes made with each
release, update "docs/releases.rst" with the changes, and apply commit directly to master
before release.
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/platonnetwork/platon-typing",
"name": "platon-typing",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5, <4",
"maintainer_email": "",
"keywords": "platon",
"author": "Shinnng",
"author_email": "shinnng@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/95/25/0eb5997c7199e8986258b2f7cfd9e2c6a0db148ce36c56d940fbd460185d/platon-typing-1.2.0.tar.gz",
"platform": null,
"description": "# platon-typing\n\n[](https://gitter.im/platonnetwork/platon-typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://circleci.com/gh/platonnetwork/platon-typing)\n[](https://badge.fury.io/py/platon-typing)\n[](https://pypi.python.org/pypi/platon-typing)\n[](http://platon-typing.readthedocs.io/en/latest/?badge=latest)\n \n\nCommon type annotations for platon python packages.\n\nRead more in the [documentation on ReadTheDocs](https://platon-typing.readthedocs.io/). [View the change log](https://platon-typing.readthedocs.io/en/latest/releases.html).\n\n## Quickstart\n\n```sh\npip install platon-typing\n```\n\n## Developer Setup\n\nIf you would like to hack on platon-typing, please check out the [Snake Charmers\nTactical Manual](https://github.com/platonnetwork/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-typing.git\ncd platon-typing\nvirtualenv -p python3 venv\n. venv/bin/activate\npip install -e .[dev]\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_typing/ tests/ -c \"clear; flake8 platon_typing 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-typing failed'\" ../tests ../platon_typing\n```\n\n### Release setup\n\nFor Debian-like systems:\n```\napt install pandoc\n```\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). To include changes made with each\nrelease, update \"docs/releases.rst\" with the changes, and apply commit directly to master \nbefore release.\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-typing: Common type annotations for platon python packages",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/platonnetwork/platon-typing"
},
"split_keywords": [
"platon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "059dd2fd343bea5ba2cd3b4dfaa76839d4aebc068c1d899a2b4a6bc07a6bfab6",
"md5": "a83e9c65e816f8712d4b76552a9c4270",
"sha256": "a33e85e10d80a75c4b69175dd0ea9b1be66d0ab8faa43bcd4d046d0f6c6cf29d"
},
"downloads": -1,
"filename": "platon_typing-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a83e9c65e816f8712d4b76552a9c4270",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5, <4",
"size": 6307,
"upload_time": "2022-06-01T04:23:57",
"upload_time_iso_8601": "2022-06-01T04:23:57.586552Z",
"url": "https://files.pythonhosted.org/packages/05/9d/d2fd343bea5ba2cd3b4dfaa76839d4aebc068c1d899a2b4a6bc07a6bfab6/platon_typing-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95250eb5997c7199e8986258b2f7cfd9e2c6a0db148ce36c56d940fbd460185d",
"md5": "c9120ac4d5573a9ee47184461d63893e",
"sha256": "4efd9bfe39ea652768a32ab73b66b002c71ed0fae5bd02f7fd974c863de56d03"
},
"downloads": -1,
"filename": "platon-typing-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c9120ac4d5573a9ee47184461d63893e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5, <4",
"size": 5242,
"upload_time": "2022-06-01T04:23:59",
"upload_time_iso_8601": "2022-06-01T04:23:59.800659Z",
"url": "https://files.pythonhosted.org/packages/95/25/0eb5997c7199e8986258b2f7cfd9e2c6a0db148ce36c56d940fbd460185d/platon-typing-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-01 04:23:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "platonnetwork",
"github_project": "platon-typing",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "platon-typing"
}
JSON
