Installation
We recommend that you use our binary distribution through pypi inside of a virtual environment, which supports both MacOs and Linux. On Windows we have successfully gotten pyre
to work through WSL, but do not officially support it.
#
Binary DistributionYou can get Pyre through pypi by running:
See our Getting Started section for a more detailed example, including setup for a virtual environment.
#
IDE IntegrationPyre supports the Language Server Protocol. We provide an extension for VSCode that will automatically try to connect to a running server. You can also directly interact with the LSP by piping the appropriate JSON
into pyre persistent
.
#
Building from SourceThese instructions are known to work on Mac OS X (tested on High Sierra through OSX 10.13 - even though binaries are compatible with versions as old as 10.11) and Linux (tested on Ubuntu 16.04 LTS and CentOS 7).
#
RequirementsIn addition to Python and watchman, we need a working OCaml compiler. We use Opam to manage our compiler and libraries. You can get Opam via various package management systems. Please follow their instructions for your particular operating system.
Once you have Opam on your system, switch to a current compiler with
This will compile the compiler from scratch and is likely going to take some time on your system.
#
Getting the SourceWith a working OCaml, you can clone the source from GitHub with
You can complete the setup of your development environment with
This will generate a Makefile
in your checkout directory. You can subsequently build and test
pyre
with
#
Windows Subsystem for Linux (WSL) InstallOn x86_64 Windows pyre
can run via Linux using WSL.
A brief summary to get this running on Ubuntu please follow:
- Install WSL (external Microsoft Documentation)
- Once you have a login to your Linux of choice:
- Optionally: Install build environment (some dependencies of
pyre
might need to be built) - Use
pip
as described above or via a Python Virtual Environment
- Optionally: Install build environment (some dependencies of
- Here is an example using Ubuntu with a venv: