SQLAlchemy + URL dispatch wiki tutorial

This tutorial introduces an SQLAlchemy and URL dispatch-based Pyramid application to a developer familiar with Python. When finished, the developer will have created a basic wiki application with authentication and authorization.

For cut and paste purposes, the source code for all stages of this tutorial can be browsed on GitHub at GitHub for a specific branch or version under docs/tutorials/wiki2/src, which corresponds to the same location if you have Pyramid sources.

• Background
• Design
  • Overall
  • Models
  • Wiki Views
  • Security
  • Summary
• Installation
  • Before you begin
  • Install SQLite3 and its development packages
  • Install cookiecutter
  • Generate a Pyramid project from a cookiecutter
  • Change directory into your newly created project
  • Set and use a VENV environment variable
  • Create a virtual environment
  • Upgrade packaging tools in the virtual environment
  • Installing the project in development mode
  • Initialize and upgrade the database using Alembic
  • Load default data
  • Run the tests
  • Expose test coverage information
  • Test and coverage cookiecutter defaults
  • Start the application
  • Visit the application in a browser
  • Decisions the cookiecutter backend option sqlalchemy has made for you
• Basic Layout
  • Application configuration with __init__.py
  • Route declarations
  • View declarations via the views package
  • Content models with the models package
• Defining the Domain Model
  • Declaring dependencies in our setup.py file
  • Running pip install -e .
  • Remove mymodel.py
  • Add user.py
  • Add page.py
  • Edit models/__init__.py
  • Migrate the database with Alembic
  • Edit scripts/initialize_db.py
  • Populating the database
  • View the application in a browser
• Defining Views
  • Adding the docutils dependency
  • Static assets
  • Adding routes to routes.py
  • Adding view functions in views/default.py
  • Adding templates
  • Viewing the application in a browser
• Adding authentication
  • Authenticating requests
  • Login, logout
  • Viewing the application in a browser
• Adding authorization
  • Add user principals
  • Add the authorization policy
  • Add resources and ACLs
  • Add view permissions
  • Viewing the application in a browser
• Adding Tests
  • Test the views
  • Functional tests
  • View the results of all our edits to tests subpackage
  • Running the tests
• Distributing Your Application