[](https://github.com/facebook/pyre-check/actions/workflows/lint.yml)
[](https://github.com/facebook/pyre-check/actions/workflows/tests.yml)
[](https://github.com/facebook/pyre-check/actions/workflows/pyre.yml)
<p align="center">
<img src="https://raw.githubusercontent.com/facebook/pyre-check/master/logo.png">
</p>
Pyre is a performant type checker for Python compliant with [PEP 484](https://www.python.org/dev/peps/pep-0484/). Pyre can analyze codebases with millions of lines of code incrementally – providing instantaneous feedback to developers as they write code.
Pyre ships with **Pysa**, a security focused static analysis tool we've built on top of Pyre that reasons about data flows in Python applications. Please refer to our [documentation](https://pyre-check.org/docs/pysa-basics.html) to get started with our security analysis.
## Requirements
To get started, you need [Python 3.6 or later](https://www.python.org/getit/) and [watchman](https://facebook.github.io/watchman/) working on your system. On *MacOS* you can get everything with [homebrew](https://brew.sh/):
```bash
$ brew install python3 watchman
```
On *Ubuntu*, *Mint*, or *Debian*; use `apt-get` and [homebrew](https://brew.sh/):
```bash
$ sudo apt-get install python3 python3-pip python3-venv
$ brew install watchman
```
We tested Pyre on *Ubuntu 18.04.5 LTS*, *CentOS 7*, as well as *OSX 10.11* and later.
## Setting up a Project
We start by creating an empty project directory and setting up a virtual environment:
```bash
$ mkdir my_project && cd my_project
$ python3 -m venv ~/.venvs/venv
$ source ~/.venvs/venv/bin/activate
(venv) $ pip install pyre-check
```
Next, we teach Pyre about our new project:
```bash
(venv) $ pyre init
```
This command will set up a configuration for Pyre (`.pyre_configuration`) as well as watchman (`.watchmanconfig`) in your project's directory. Accept the defaults for now – you can change them later if necessary.
## Running Pyre
We are now ready to run Pyre:
```bash
(venv) $ echo "i: int = 'string'" > test.py
(venv) $ pyre
ƛ Found 1 type error!
test.py:1:0 Incompatible variable type [9]: i is declared to have type `int` but is used as type `str`.
```
This first invocation will start a daemon listening for filesystem changes – type checking your project incrementally as you make edits to the code. You will notice that subsequent invocations of `pyre` will be faster than the first one.
For more detailed documentation, see https://pyre-check.org.
## Join the Pyre community
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to help out.
## License
Pyre is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://pyre-check.org/",
"name": "pyre-check-nightly",
"maintainer": "Facebook",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "pyre@fb.com",
"keywords": "typechecker development",
"author": "Facebook",
"author_email": "pyre@fb.com",
"download_url": "https://files.pythonhosted.org/packages/e2/21/3af237e4ce6c2b56e819f2b560ed2a03f372f29ba3fb1333a3bb7ddb735d/pyre-check-nightly-0.0.101618485070.tar.gz",
"platform": "",
"description": "[](https://github.com/facebook/pyre-check/actions/workflows/lint.yml)\n[](https://github.com/facebook/pyre-check/actions/workflows/tests.yml)\n[](https://github.com/facebook/pyre-check/actions/workflows/pyre.yml)\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/facebook/pyre-check/master/logo.png\">\n</p>\n\nPyre is a performant type checker for Python compliant with [PEP 484](https://www.python.org/dev/peps/pep-0484/). Pyre can analyze codebases with millions of lines of code incrementally \u2013 providing instantaneous feedback to developers as they write code.\n\nPyre ships with **Pysa**, a security focused static analysis tool we've built on top of Pyre that reasons about data flows in Python applications. Please refer to our [documentation](https://pyre-check.org/docs/pysa-basics.html) to get started with our security analysis.\n\n## Requirements\nTo get started, you need [Python 3.6 or later](https://www.python.org/getit/) and [watchman](https://facebook.github.io/watchman/) working on your system. On *MacOS* you can get everything with [homebrew](https://brew.sh/):\n```bash\n$ brew install python3 watchman\n```\nOn *Ubuntu*, *Mint*, or *Debian*; use `apt-get` and [homebrew](https://brew.sh/):\n```bash\n$ sudo apt-get install python3 python3-pip python3-venv\n$ brew install watchman\n```\nWe tested Pyre on *Ubuntu 18.04.5 LTS*, *CentOS 7*, as well as *OSX 10.11* and later.\n\n## Setting up a Project\nWe start by creating an empty project directory and setting up a virtual environment:\n\n```bash\n$ mkdir my_project && cd my_project\n$ python3 -m venv ~/.venvs/venv\n$ source ~/.venvs/venv/bin/activate\n(venv) $ pip install pyre-check\n```\n\nNext, we teach Pyre about our new project:\n```bash\n(venv) $ pyre init\n```\nThis command will set up a configuration for Pyre (`.pyre_configuration`) as well as watchman (`.watchmanconfig`) in your project's directory. Accept the defaults for now \u2013 you can change them later if necessary.\n\n## Running Pyre\nWe are now ready to run Pyre:\n```bash\n(venv) $ echo \"i: int = 'string'\" > test.py\n(venv) $ pyre\n \u019b Found 1 type error!\ntest.py:1:0 Incompatible variable type [9]: i is declared to have type `int` but is used as type `str`.\n```\nThis first invocation will start a daemon listening for filesystem changes \u2013\u00a0type checking your project incrementally as you make edits to the code. You will notice that subsequent invocations of `pyre` will be faster than the first one.\n\nFor more detailed documentation, see https://pyre-check.org.\n\n## Join the Pyre community\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for how to help out.\n\n## License\n\nPyre is licensed under the MIT license.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A performant type checker for Python",
"version": "0.0.101618485070",
"split_keywords": [
"typechecker",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "dacd5f6503984cfeeb03dc3c1daa3770",
"sha256": "f72fe36e37809cf8cb9193fde8287371c58e8767567712521700b8911a23f0f6"
},
"downloads": -1,
"filename": "pyre_check_nightly-0.0.101618485070-py3-none-macosx_10_11_x86_64.whl",
"has_sig": false,
"md5_digest": "dacd5f6503984cfeeb03dc3c1daa3770",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 15409156,
"upload_time": "2021-04-15T11:35:38",
"upload_time_iso_8601": "2021-04-15T11:35:38.546784Z",
"url": "https://files.pythonhosted.org/packages/8a/8e/9ab7db6536469177f9dcf4c57a6be7d3bc6f06da6f8db8ffbd243b5a4635/pyre_check_nightly-0.0.101618485070-py3-none-macosx_10_11_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "389aa0adf675df68b98dd03ee1f2c80f",
"sha256": "bb9ca212145d2b818a6120cdfbe86242cab956450f2b3f5d0f5e162d3d35bba1"
},
"downloads": -1,
"filename": "pyre_check_nightly-0.0.101618485070-py3-none-manylinux1_x86_64.whl",
"has_sig": false,
"md5_digest": "389aa0adf675df68b98dd03ee1f2c80f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 23653220,
"upload_time": "2021-04-15T11:35:35",
"upload_time_iso_8601": "2021-04-15T11:35:35.029024Z",
"url": "https://files.pythonhosted.org/packages/2a/62/92f4cbc2fb4c1f2e8b32b13011f86f6405b05c799c37cd2cc7087c038f22/pyre_check_nightly-0.0.101618485070-py3-none-manylinux1_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "6fa4ae46c991594f90ac53089d4257ec",
"sha256": "34a3af14d0133be9b9c2467fde4b545dae9f060dfa595d6dc1c15e85d86949e6"
},
"downloads": -1,
"filename": "pyre-check-nightly-0.0.101618485070.tar.gz",
"has_sig": false,
"md5_digest": "6fa4ae46c991594f90ac53089d4257ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 14609400,
"upload_time": "2021-04-15T11:35:41",
"upload_time_iso_8601": "2021-04-15T11:35:41.993685Z",
"url": "https://files.pythonhosted.org/packages/e2/21/3af237e4ce6c2b56e819f2b560ed2a03f372f29ba3fb1333a3bb7ddb735d/pyre-check-nightly-0.0.101618485070.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-04-15 11:35:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pyre-check-nightly"
}
JSON