Quickstart¶

Eager to get started? This page gives a good introduction to Platzky.

A Minimal Application¶

Install Platzky:

$ pip install platzky

Create a configuration file config.yml:

APP_NAME: My Platzky App
SECRET_KEY: change-this-to-something-secret

DB:
  TYPE: json_file
  PATH: data.json

LANGUAGES:
  en:
    name: English
    flag: uk
    country: GB

Run the application:

$ flask --app "platzky.platzky:create_app(config_path='config.yml')" run

Open http://127.0.0.1:5000 in your browser.

Configuration¶

Platzky uses a YAML configuration file. Start with the provided template:

$ cp config-template.yml config.yml
$ # Edit config.yml with your settings

See Configuration Handling for detailed configuration options.

What to Do Next¶

Read about Configuration Handling to understand all available options
Learn about different Database Backends backends
Check the API Reference reference for detailed information