Metadata-Version: 2.1
Name: progressive-mypy
Version: 0.0.0
Summary: An awesome package is coming soon! 🎉
Home-page: https://github.com/Kludex/progressive-mypy
Author: Marcelo Trylesinski
Author-email: marcelotryle@email.com
License: MIT
Project-URL: Twitter, https://twitter.com/marcelotryle
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: coverage[toml] (>=6.2) ; extra == 'test'
Requires-Dist: pytest (>=6.2.5) ; extra == 'test'

<h1 align="center">
    <strong>progressive-mypy</strong>
</h1>
<p align="center">
    <a href="https://github.com/Kludex/progressive-mypy" target="_blank">
        <img src="https://img.shields.io/github/last-commit/Kludex/progressive-mypy" alt="Latest Commit">
    </a>
        <img src="https://img.shields.io/github/workflow/status/Kludex/progressive-mypy/Test">
        <img src="https://img.shields.io/codecov/c/github/Kludex/progressive-mypy">
    <br />
    <a href="https://pypi.org/project/progressive-mypy" target="_blank">
        <img src="https://img.shields.io/pypi/v/progressive-mypy" alt="Package version">
    </a>
    <img src="https://img.shields.io/pypi/pyversions/progressive-mypy">
    <img src="https://img.shields.io/github/license/Kludex/progressive-mypy">
</p>

This is a package made for improve type annotation coverage on big repositories.

What this package does:
- [`dump`](#dump): Generates a **list** of files that are currently not type annotated.
- [`check`](#check): Given an input of files:
  - If a file is in the **list**, and is fully type annotated, it will be removed from the **list**.
  - If a file is in the **list**, and is **not** fully annotated, it will be ignored.
  - If a file is **not** in the **list**, and is fully annotated, it will be ignored.
  - If a file is **not** in the **list**, and is **not** fully annotated, it will raise errors.

## Installation

```bash
pip install progressive-mypy
```

## Usage

### Dump

## License

This project is licensed under the terms of the MIT license.


