Skip to content



Repository files navigation

RealWorld Example App

CircleCI for pyramid-realworld-example-app (master branch) Test coverage (master branch) Type Hints coverage (master branch) Supported Python versions License: MIT Built by these great folks! Talk to us in #pyramid on Freenode IRC

Pyramid codebase containing real world examples (CRUD, authentication, authorization, advanced patterns, and so on) that adhere to the RealWorld specification and API.


This is deployed on Heroku and is configured to automatically sleep after an hour of inactivity. If you get Application Error, refresh again in a minute or two.

This codebase was created to demonstrate a fully fledged fullstack application built with Pyramid including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Pyramid community style guides and best practices. You are encouraged to use it as a scaffold/template for your next Pyramid project.

For more information on how this works with other frontends/backends, head over to the RealWorld repo.

How it works

The application is built with Pyramid, using pyramid_openapi3 for request/response validation and pyramid_deferred_sqla for PostgreSQL integration. It is deployed to Heroku.

Pyramid serves one of the frontends (Elm) on root, so it is easier to understand how things fit together. The frontend is interchangeable. You can use any frontend.

Getting started

To set up your development environment, there are some dependencies you need to install on your system. You can either install them manually, or use Nix and direnv to install them automatically (except Docker which you need to install manually).

First ensure that you have Docker installed on your system. Then choose one option to install pre-requisites.

Option 1: Install pre-requisites manually

Activate the virtual environment, then continue to Install RealWorld Example App.

If you have any dependency related issue, check out ./shell.nix for the specific version of dependencies.

Option 2: Install pre-requisites using Nix

Install and Run RealWorld Example App

Docker should be running. Then you can run:

$ cd ~/projects
$ git clone
$ cd pyramid-realworld-example-app
$ make install
$ make start-pgsql
$ make devdb
$ make run

Now point your browser to:

To run unit tests, mypy typing checker and flake8 linter:

$ make tests

To stop Docker and clean the container, you can run:

$ make stop-pgsql
$ make clean-pgsql


Pyramid and OpenAPI3 based RealWorld implementation.







No packages published


  • Python 78.8%
  • Nix 8.7%
  • Shell 4.5%
  • Makefile 4.1%
  • HTML 1.9%
  • Dockerfile 1.5%
  • Mako 0.5%