Metadata-Version: 2.1
Name: istub
Version: 0.1.0
Summary: Validator for type annotations
Home-page: https://youtype.github.io/istub/
License: MIT
Keywords: stubs,type-annotations,pyright,mypy
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Stubs Only
Requires-Dist: pip
Project-URL: Bug Tracker, https://github.com/youtype/istub/issues
Project-URL: Documentation, https://youtype.github.io/istub/
Project-URL: Repository, https://github.com/youtype/istub
Project-URL: Source, https://github.com/youtype/istub
Description-Content-Type: text/markdown

# 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
```

## 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.

