Platzky Documentation

Welcome to Platzky’s documentation. Platzky is a lightweight web application engine that aims to provide a simple and easy way to create and run web applications in Python.

Platzky is built on Flask and provides additional features like:

• Multi-language support with automatic locale detection

• Pluggable database backends (JSON file, Google Cloud Storage, MongoDB)

• Built-in blog and SEO modules

• Extensible plugin system

User’s Guide

This part of the documentation focuses on step-by-step instructions for getting started with Platzky and building applications.

• Installation
  • Python Version
  • Installing Platzky
  • Verify Installation
• Quickstart
  • A Minimal Application
  • Configuration
  • What to Do Next
• Configuration Handling
  • Configuration Basics
  • Configuration Reference
  • Complete Example
  • Environment-Specific Configuration
  • Configuration Validation
• Database Backends
  • Configuring the Database
  • Available Backends
  • Choosing a Backend
  • Database Migrations
  • Health Checks
  • Further Reading
• Telemetry
  • Why Telemetry?
  • Installation
  • Configuration
  • What Gets Traced?
  • Deployment Examples
  • Analyzing Traces
  • Best Practices
  • Troubleshooting
  • Further Reading
• Plugins
  • Overview
  • Quick Start with Cookiecutter
  • Notifier Plugins
  • Content Transformer Plugins
  • Other Engine Extensions
  • Packaging a Plugin
  • Plugin Configuration
  • Admin Help Page
  • Listing Installed Plugins
  • Translation Support
  • Legacy Plugins

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API Reference
  • Engine
  • Configuration
  • Database
  • Models

Additional Notes

• Changelog
  • CHANGELOG
• License