Getting Started

Project layout

Keep your Plain Language sources organized alongside compiled output and assets.

Start a project Read the reference

Layout goals

  • Clear separation of source and output.
  • Easy to test or deploy compiled Python.
  • Room for assets and config.

Recommended structure

A clean layout makes it easy for teams to navigate, build, and ship Plain Language projects.

project tree 
my-app/
  src/
    app.pln
    api.pln
    jobs/
      nightly_report.pln
  dist/
    app.py
    api.py
  data/
    samples.json
  README.md

Source and output

Store your Plain Language files in src, then compile to a dist folder so the generated Python stays separate. This also keeps git diffs readable.

  • Use plain compile src/app.pln to emit dist/app.py.
  • Check in only the .pln sources when possible.
  • Commit compiled output if you need audited deploys.

Config and assets

Keep JSON, templates, and media files in dedicated folders so your code stays focused.

Tip

Pair each module with a config file for data-driven flows and enterprise integrations.