/masonite

The Modern And Developer Centric Python Web Framework. Be sure to read the documentation and join the Slack channel questions: http://slack.masoniteproject.com

Primary LanguagePythonMIT LicenseMIT

Python Version License License License

About Masonite

The modern and developer centric Python web framework that strives for an actual batteries included developer tool with a lot of out of the box functionality with an extremely extendable architecture. Masonite is perfect for beginner developers getting into their first web applications as well as experienced devs that need to utilize the full potential of Masonite to get their applications done.

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. Use it for your next SaaS! Try it once and you’ll fall in love.

  • Having a simple and expressive routing engine
  • Extremely powerful command line helpers called craft commands
  • A simple migration system, removing the "magic" and finger crossing of migrations
  • A great Active Record style ORM called Orator
  • A great filesystem architecture for navigating and expanding your project
  • An extremely powerful Service Container (IOC Container)
  • Service Providers which makes Masonite extremely extendable

Learning Masonite

Masonite strives to have extremely comprehensive documentation. All documentation can be Found Here and would be wise to go through the tutorials there. If you find any discrepencies or anything that doesn't make sense, be sure to comment directly on the documentation to start a discussion!

Also be sure to join the Slack channel!

Requirements

  • Python 3.4 +
  • OpenSSL (latest version)
  • Pip

Linux

If you are running on a Linux flavor, you’ll need a few extra packages before you start. You can download these packages by running:

$ sudo apt-get install python-dev libssl-dev

Instead of python-dev you may need to specify your Python version

$ sudo apt-get install python3.6-dev libssl-dev

Windows

With windows you will need to have the latest OpenSSL version. Install OpenSSL 32-bit or 64-bit

Mac

If you do not have the latest version of OpenSSL you will encounter some installation issues with creating new applications since we need to download a zip of the application via GitHub.

With Mac you can install OpenSSL through brew.

brew install openssl

Python 3.6 does not come preinstalled with certificates so you may need to install certificates with this command:

/Applications/Python\ 3.6/Install\ Certificates.command

You should now be good to install new Masonite application of Mac :)

Python 3.7

If you are using Python 3.7, add it to your PATH Environment variable.

Open Windows PowerShell and run: pip install masonite-cli

Add C:\Users\%USERNAME%\.AppData\Programs\Python\Python37\Scripts\ to PATH Environment variable.

Note: PATH variables depend on your installation folder

Installation:

    $ pip3 install masonite-cli :: (may need sudo if using UNIX) ::
    $ craft new project
    $ cd project
    $ craft install
    $ craft serve

Go to http://localhost:8000/

* * * *

Not all computers are made the same so you may have some trouble installing Masonite depending on your machine. If you have any issues be sure to read the Known Installation Issues Documentation.

* * * *

Contributing

Please read the Contributing Documentation here. Development will be on the current releasing branch of the Core Repository (typically the develop branch) so check open issues, the current Milestone and the releases in that repository. Ask any questions you like in the issues so we can have an open discussion about the framework, design decisions and future of the project.

Contributors

Thank you for those who have contributed to Masonite!

Vaibhav Mule
Martín Peveri
Adorifski
Abram C. Isola
Raphael Schubert
Mitch Dennett

License

The Masonite framework is open-sourced software licensed under the MIT license.

Hello World

Getting started is very easy. Below is how you can get a simple Hello World application up and running.

Installation

You can easily create new applications with craft. To create a new application run:

$ craft new project_name

* * * *

NOTE: If you do not have the craft command, you can run pip install masonite-cli which will install craft command line tool.

* * * *

This command will create a new directory called project_name with our new Masonite project.

You can now cd into this directory by doing:

$ cd project_name

Now we just need to add the pip dependencies. You can run pip3 install -r "requirements.txt" or you can run the craft command:

$ craft install

* * * *

NOTE: Python craft commands are essentially wrappers around common mundane tasks. Read the docs about the craft command tool to learn more

* * * *

This will install all the required dependencies to run this framework. Now we can run the craft command:

$ craft serve

This will run the server at localhost:8000. Navigating to that URL should show the Masonite welcome message.

If that port is blocked you can specify a port by running:

$ craft serve --port 8080

Or specify a host by running:

$ craft serve --host 192.168.1.283

The server can also be auto reloaded by passing in a -r flag (short for --reload)

$ craft serve -r

This will reload the server when Masonite detects file changes. This is very similiar to Django.

Hello World

All web routes are in routes/web.py. In this file is already the route to the welcome controller. To start your hello world example just add something like:

Get().route('/hello/world', 'HelloWorldController@show'),

our routes constant file should now look something like:

ROUTES = [
    Get().route('/', 'WelcomeController@show'),
    Get().route('/hello/world', 'HelloWorldController@show'),
]

* * * *

NOTE: Notice this new interesting string syntax in our route. This will grant our route access to a controller (which we will create below)

* * * *

Since we used a string controller we don't have to import our controller into this file. All imports are done through Masonite on the backend.

You'll notice that we have a reference to the HelloWorldController class which we do not have yet. This framework uses controllers in order to separate the application logic. Controllers can be looked at as the views.py in a Django application. The architectural standard here is 1 controller per file.

In order to make the HelloWorldController we can use a craft command:

$ craft controller HelloWorld

This will scaffold the controller for you and put it in app/http/controllers/HelloWorldController.py

We will have a show() method by default which is the typical method we will use to "show" our views and content.

Inside the HelloWorldController we can make our show method like this:

def show(self):
    """ Show Hello World Template """
    return view('helloworld')

As you see above, we are returning a helloworld template but we do not have that yet. All templates are in resources/templates. We can simply make a file called helloworld.html or run the craft command:

$ craft view helloworld

Which will create the resources/templates/helloworld.html template for us.

Lastly all templates run through the Jinja2 rendering engine so we can use any Jinja2 code inside our template like:

inside the resources/views/helloworld.html

{{ 'Hello World' }}

Now just run the server:

$ craft serve

And navigate to localhost:8000/hello/world and you will see Hello World in your browser.

Happy Crafting!