https://github.com/youtype/istub
Generator and validator for type annotations
https://github.com/youtype/istub
Last synced: 24 days ago
JSON representation
Generator and validator for type annotations
- Host: GitHub
- URL: https://github.com/youtype/istub
- Owner: youtype
- License: mit
- Created: 2022-07-17T13:35:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-23T09:45:38.000Z (about 1 year ago)
- Last Synced: 2025-01-14T20:18:20.426Z (9 months ago)
- Language: Python
- Size: 154 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iStub
Validator for type annotations.
- [x] Code style checking with [flake8](https://flake8.pycqa.org/en/latest/) and [ruff](https://github.com/astral-sh/ruff)
- [x] Type checking with [mypy](https://mypy-lang.org/) and [pyright](https://github.com/microsoft/pyright)
- [x] Type consistency checking with [mypy.stubtest](https://mypy.readthedocs.io/en/stable/stubtest.html)
## 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
ruff: 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.