Introduction and Installaton

This is an unreleased version. Scheduled Release June 15th 2018

Masonite is the rapid application Python development framework that strives for: beautiful and elegant syntax, actual batteries included with a lot of out of the box functionality, and extremely extendable. Masonite works hard to be fast and easy from install to deployment so developers can go from concept to creation in as quick and efficiently as possible. Try it once and you’ll fall in love.

Some Notable Features Shipped With Masonite

  • Easily send emails with the Mail Provider and the SMTP and Mailgun drivers.

  • Send websocket requests from your server with the Broadcast Provider and Pusher and Ably drivers.

  • IOC container and auto resolving dependency injection.

  • Service Providers to easily add functionality to the framework.

  • Extremely simple static files configured and ready to go.

  • Active Record style ORM called Orator.

  • An extremely useful command line tool called craft commands.

  • Extremely extendable.

These, among many other features, are all shipped out of the box and ready to go. Use what you need when you need it.


In order to use Masonite, you’ll need:

  • Python 3.4+

  • Pip3


If you are running on a Linux flavor, you’ll need the Python dev package. You can download this package by running:

$ sudo apt-get install python-dev

Or you may need to specify your python3.x-dev version:

$ sudo apt-get install python3.6-dev


Masonite works at being simple to install and get going. We use a simple command line that will become your best friend. You’ll never want to develop again without it. We call it the craft command line tool.

We can download our craft command line tool by just running:

$ pip3 install masonite-cli

You may have to use sudo if you are on a UNIX machine

All examples of pip in this documentation are based on pip3. If you see a pip command it is implied you are using a Python 3 pip command and not a Python 2 pip command

Great! We are now ready to create our first project. We should have the new craft command. We can check this by running:

$ craft

This should show a list of command options. If it doesn't then try closing your terminal and reopening it or running it with sudo if you are on a UNIX machine. We are currently only interested in the craft new command. To create a new project just run:

$ craft new project_name
$ cd project_name

This will get the latest Masonite project template and unzip it for you. We just need to go into our new project directory and install the dependencies in our requirements.txt file.

You can optionally create a virtual environment if you don't want to install all of masonite's dependencies on your systems Python. If you use virtual environments then create your virtual environment by running:

$ python -m venv venv
$ source venv/bin/activate

or if you are on Windows:

$ python -m venv venv
$ ./venv/Scripts/activate

The pythoncommand here is utilizing Python 3. Your machine may run Python 2 (typically 2.7) by default. You may set an alias on your machine for Python 3 or simply run python3anytime you see the pythoncommand.

For example, you would run python3 -m venv venv instead of python -m venv venv

Now lets install our dependencies. We can do this simply by using a craft command:

$ craft install

This command is just a wrapper around the pipcommand with a few added Masonite specific install instructions. This installs all the required dependencies of Masonite, creates a .env file for us, generates a new secret key, and puts that secret key in our .env file.

Python 3.7

Two of the libraries that Masonite uses are currently not up to date with Python 3.7 installation. These libraries have old versions the .pyc files inside their distributions and need to be installed outside of the normal install workflow. Installing for Python 3.7 will be:

$ pip install pycparser
$ pip install git+
$ craft install

Running The Server

After it’s done we can just run the server by using another craft command:

$ craft serve

You can also run the server in auto-reload mode which will rerun the server when file changes are detected:

$ craft serve -r

Congratulations! You’ve setup your first Masonite project! Keep going to learn more about how to use Masonite to build your applications.

You can learn more about craft by reading The Craft Command documentation or continue on to learning about how to create web application by first reading the Routing documentation

Last updated