Update README.md

This commit is contained in:
Shunsuke Shibayama 2022-12-13 16:11:00 +09:00
parent f2a0da1960
commit 2c3e37d2a4
1 changed files with 9 additions and 3 deletions

View File

@ -4,6 +4,12 @@
## Installation
### pip
```bash
pip install pype
```
### cargo (rust package manager)
```bash
@ -16,17 +22,17 @@ or download the binary from [the releases page](https://github.com/mtshiba/pype/
* Performance: pype can inspect Python scripts on average __100 times faster__ than pytype and pyright. This is largely due to the fact that pype is implemented in Rust, whereas pytype is implemented in Python.
![performance](images/performance.png)
![performance](https://raw.githubusercontent.com/mtshiba/pype/main/images/performance.png)
* Detailed analysis
pype can do more than the usual type testing. For example, it can detect out-of-bounds accesses to lists and accesses to nonexistent keys in dicts.
![analysis](images/analysis.png)
![analysis](https://raw.githubusercontent.com/mtshiba/pype/main/images/analysis.png)
* Reports readability: While pytype's error reports are crude, showing only that an error has occurred, pype shows where the error occurred and provides clear error messages.
![reports](images/reports.png)
![reports](https://raw.githubusercontent.com/mtshiba/pype/main/images/reports.png)
## How it works