Getting Started
Welcome to the wonderful world of static typing! This guide will get you from zero to a simple project that is type checked with Pyre.
#
RequirementsTo get started, you need Python 3.6 or later and watchman working on your system. On MacOS you can get everything with homebrew:
On Ubuntu, Mint, or Debian; use apt-get
:
We tested Pyre on Ubuntu 16.04 LTS, CentOS 7, as well as OSX 10.11 and later.
#
Setting up a ProjectWe start by creating an empty project directory and setting up a virtual environment:
Next, we teach Pyre about our new project:
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 PyreWe are now ready to run Pyre:
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.