# iStub
Validator for type annotations.
- [ ] Stubs generation
- [x] Code style checking with `flake8`
- [x] Type checking with `mypy` and `pyright`
- [x] Type consistency checking with `mypy.stubtest`
## Usage
### Basic usage
Let's assume that you want to check `mylib-stubs` package against `mylib`
Create a file `istub.yml` in your project root:
```yaml
packages:
- name: mylib
path: ./mylib-stubs
checks:
mypy: true
stubtest: true
```
Run checker:
```bash
python -m istub
```
You can create a whitelist of acceptable errors:
```bash
python -m istub --update
```
### Custom configuration
```yaml
packages:
- name: mylib
path: ./mylib-stubs
checks:
mypy: true
stubtest: true
flake8: false
pyright: false
pip_install:
- pypi_dependency
- pypi_dependency2
pip_uninstall:
- dependency_to_uninstall
build:
- ./build_cmd.sh
```
## Latest changes
Full changelog can be found in [Releases](https://github.com/youtype/istub/releases).
## Versioning
`istub` version follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Support and contributing
Please reports any bugs or request new features in
[istub](https://github.com/youtype/istub/issues/) repository.
Raw data
{
"_id": null,
"home_page": "https://youtype.github.io/istub/",
"name": "istub",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "stubs,type-annotations,pyright,mypy",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/44/97/17c5b2b4a2d6c4b1bc110470a403fbe01ac23419328f2e9885c395401379/istub-0.2.4.tar.gz",
"platform": null,
"description": "# iStub\n\nValidator for type annotations.\n\n- [ ] Stubs generation\n- [x] Code style checking with `flake8`\n- [x] Type checking with `mypy` and `pyright`\n- [x] Type consistency checking with `mypy.stubtest`\n\n## Usage\n\n### Basic usage\n\nLet's assume that you want to check `mylib-stubs` package against `mylib`\n\nCreate a file `istub.yml` in your project root:\n\n```yaml\npackages:\n - name: mylib\n path: ./mylib-stubs\n checks:\n mypy: true\n stubtest: true\n```\n\nRun checker:\n\n```bash\npython -m istub\n```\n\nYou can create a whitelist of acceptable errors:\n\n```bash\npython -m istub --update\n```\n\n### Custom configuration\n\n```yaml\npackages:\n - name: mylib\n path: ./mylib-stubs\n checks:\n mypy: true\n stubtest: true\n flake8: false\n pyright: false\n pip_install:\n - pypi_dependency\n - pypi_dependency2\n pip_uninstall:\n - dependency_to_uninstall\n build:\n - ./build_cmd.sh\n```\n\n## Latest changes\n\nFull changelog can be found in [Releases](https://github.com/youtype/istub/releases).\n\n## Versioning\n\n`istub` version follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n## Support and contributing\n\nPlease reports any bugs or request new features in\n[istub](https://github.com/youtype/istub/issues/) repository.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Validator for type annotations",
"version": "0.2.4",
"project_urls": {
"Bug Tracker": "https://github.com/youtype/istub/issues",
"Documentation": "https://youtype.github.io/istub/",
"Homepage": "https://youtype.github.io/istub/",
"Repository": "https://github.com/youtype/istub",
"Source": "https://github.com/youtype/istub"
},
"split_keywords": [
"stubs",
"type-annotations",
"pyright",
"mypy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b482f42b052f1fec914f3ab633d571b1339fa76b1ce08674cbd0bff757a93392",
"md5": "2f3215ec5de2c3c488a8f26f5833ac04",
"sha256": "dac1a1d86e6846f43c8e562c2e4ed1fe2cefbaaf9829b7ce9cce844e409cf954"
},
"downloads": -1,
"filename": "istub-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f3215ec5de2c3c488a8f26f5833ac04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 14034,
"upload_time": "2023-11-29T18:48:36",
"upload_time_iso_8601": "2023-11-29T18:48:36.025911Z",
"url": "https://files.pythonhosted.org/packages/b4/82/f42b052f1fec914f3ab633d571b1339fa76b1ce08674cbd0bff757a93392/istub-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "449717c5b2b4a2d6c4b1bc110470a403fbe01ac23419328f2e9885c395401379",
"md5": "b64715a975bf7cb28bc78ed74b71804f",
"sha256": "c05a9d0ce6c6cb6acca92be01462a866867e13d37a711caae87c2dd00006a6c1"
},
"downloads": -1,
"filename": "istub-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "b64715a975bf7cb28bc78ed74b71804f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 9890,
"upload_time": "2023-11-29T18:48:37",
"upload_time_iso_8601": "2023-11-29T18:48:37.065610Z",
"url": "https://files.pythonhosted.org/packages/44/97/17c5b2b4a2d6c4b1bc110470a403fbe01ac23419328f2e9885c395401379/istub-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 18:48:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "youtype",
"github_project": "istub",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "istub"
}
JSON
