Getting Started

Here’s everything you need to start your first Pegasus project.

Watch the video

Visual learner? The above video should get you going. Else read on below for the play-by-play.

Install Prerequisites

If you haven’t already, you’ll need to install the following.

Note: It is possible to use the template without virtualenv, but it is highly recommended, and these instructions assume you are using it.

Download Pegasus

If you haven’t already, you’ll need to purchase a Pegasus License at

From the “Downloads” page, download the latest version of the Pegasus template file and save it somewhere on your local file system.

Setup a Python3 virtualenv

It’s recommended that you setup your project in a virtualenv. Here are some reasons why.

Follow one of the sections below depending on how you want to manage your virtualenvs.

Using virtualenv

After installing prerequisites, run the following command wherever you want to create the virtualenv. This will create the environment in the {{ project_name_env }} directory.

virtualenv -p python3 {{ project_name_env }}

To activate the environment then run:

source {{ project_name_env }}/bin/activate

You will need to activate this environment every time you work on your project.

Alternative instructions using virtualenvwrapper

Virtualenvwrapper is an optional convenience tool that helps manage virturalenvs.

If you choose to use virtualenvwrapper you can use the following command to create your environment. This can be run from anywhere since virtualenvwrapper manages the location of your envs for you.

mkvirtualenv -p python3 {{ project_name }}

Then to activate the environment you simply use:

workon {{ project_name }}

Setup Pegasus

To run pegasus you’ll first need to install the installer and its dependencies.

To do this, from inside your virtualenv just run:

pip install pegasus-installer

Create your project

Go into the directory where you wish to create your project and run the following command. You will need to replace /path/to/ with the path to the downloaded file above.

pegasus /path/to/

The command will run you through a series of configuration prompts. Just fill in your project information for all the sections and let it complete.

Once the command runs a new folder with your project’s name will be created.

Enter the project directory

cd {{ project_name }}

You should see a lot of newly created files for your project including a file.

Install package requirements

pip install -r requirements.txt

Setup database

python ./ migrate


python ./ runserver

Go to http://localhost:8000 and you should see the default Pegasus landing page!


Create a User

To create your first user account, just go through the sign up flow in your web browser.

From there you should be able to access all bulit-in functionality and examples.

Building Your Application

At this point, Pegasus has installed scaffolding for all of the user management, authentication, and (optionally) team views, and given you a beautiful base UI template and clear code structure to work from.

Now that you’re up and running it’s time for the fun part: building your new application!

The can obviously be done however you like. Some examples of things you might want to do next include:

  • Customize your landing page and setup a pricing page
  • Start modifying the list of navigation tabs and logged-in user experience
  • Create a new django app and begin building out your data models in

For some initial pointers on where to to make Pegasus your own, head on over to the Customizations Page.

For the nitty-gritty details on setting up things like email, error logging, sign up flow, analytics, and more go to Settings and Configuration.