Jam.py documentation

How the documentation is organized

Here is an overview of how the documentation is organized, to help you find out where to look for specific things:

Getting started topics describe how to install the framework, create a new project, develop a web application step-by-step, and deploy it.

Programming guides discuss key topics and concepts at a fairly high level and provide useful background information and explanation.

Business application builder is a detailed description of the Application Builder used for application development and database administration.

Class reference guides contain technical reference for Jam.py classes APIs.

FAQ topics covers most frequently asked questions.

How to contains code examples that can be useful to quickly accomplish common tasks.

Or visit the table of contents or even

Jam.py Application Design Tips.

To download this document as a single PDF, please visit:


The PDF is built instantly after every commit into the repository. Hence, some data on this site might be older than the PDF.

Video Tutorials

If you are new to Jam.py, we highly recommend that you watch these video tutorials.

It is recommended to watch these videos with a resolution of 1080p

Tutorial 1 - Working with files and images

Tutorial 2 - Working with details

Tutorial 3 - Users, roles, audit trail/change history

Tutorial 4 - Task tree

Tutorial 5 - Forms

Tutorial 6 - Form events

Tutorial 7 - Data aware controls

Tutorial 8 - Datasets

Tutorial 9 - Datasets Part 2

Tutorial 10 - Fields and filters

Tutorial 11 - Client-server interactions

Tutorial 12 - Working with data on the server