Skip to content
Pyramid and OpenAPI3 based RealWorld implementation.
Branch: master
Clone or download
Pull request Compare This branch is 55 commits ahead of gothinkster:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci purge CircleCI cache Jul 16, 2019
.docker initial Postgres support Apr 22, 2019
.heroku
etc Split alembic configuration into alembic.ini May 21, 2019
src/conduit Fix typing in main() Jun 11, 2019
.aspell.en.pws
.coveragerc scaffold Apr 22, 2019
.editorconfig scaffold Apr 22, 2019
.flake8 scaffold Apr 22, 2019
.gitattributes scaffold Apr 22, 2019
.gitignore Update Pipfile.lock flake8-tuple version. (#55) Jul 16, 2019
.isort.cfg
.pre-commit-config.yaml add bandit security checker to pre-commit (#40) Jun 6, 2019
.travis.yml Add support for Travis CI (#39) May 31, 2019
Aptfile scaffold Apr 22, 2019
LICENSE Add badges Apr 22, 2019
Makefile
Pipfile add bandit security checker to pre-commit (#40) Jun 6, 2019
Pipfile.lock Update Pipfile.lock flake8-tuple version. (#55) Jul 16, 2019
Procfile scaffold Apr 22, 2019
alembic.ini Split alembic configuration into alembic.ini May 21, 2019
app.json reviewapps tweaks May 12, 2019
logo.png add pyramid's logo to logo.png Jun 9, 2019
mypy.ini Add initial support for Articles (#13) May 7, 2019
readme.md Wider clickable area Jun 10, 2019
runtime.txt scaffold Apr 22, 2019
setup.py Add badges Apr 22, 2019

readme.md

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, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo (app)    Demo (api)

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 styleguides & 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

Pyramid using pyramid_openapi3 for request/response validation and pyramid_deferred_sqla for PostgreSQL integration. Deployed to Heroku.

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

Getting started

You need to have docker, pipenv and Python 3.7 installed on your machine. Docker should be running. Then you can run:

$ 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 container, you can run:

$ make stop-pgsql
$ make clean-pgsql
You can’t perform that action at this time.