ZODB + Traversal Wiki Tutorial

This tutorial introduces a ZODB and traversal-based Pyramid application to a developer familiar with Python. It will be most familiar to developers with previous Zope experience. When finished, the developer will have created a basic Wiki application with authentication.

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/wiki/src, which corresponds to the same location if you have Pyramid sources.

• Background
• Design
  • Overall
  • Models
  • Views
  • Security
  • Summary
• Installation
  • Before you begin
  • 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
  • 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 zodb has made for you
• Basic Layout
  • Application configuration with __init__.py
  • Resources and models with models.py
  • Views With views.py
  • Configuration in development.ini
• Defining the Domain Model
  • Delete the database
  • Edit models.py
  • View the application in a browser
• Defining Views
  • Declaring Dependencies in Our setup.py File
  • Running pip install -e .
  • Adding view functions in views.py
  • Adding templates
  • Viewing the application in a browser
• Adding authorization
  • Access control
  • Login, logout
  • Reviewing our changes
  • Viewing the application in a browser
• Adding Tests
  • Test the models
  • Test the views
  • Functional tests
  • View the results of all our edits to tests.py
  • Running the tests
• Distributing Your Application