Learning path

This page is a practical route for a new developer learning PyVELM.

If you are starting from zero, follow the sections in order. If you already know Odoo-style ORM patterns, jump to day 2.

Day 1: Run the app and inspect the shell

1. Complete Getting started.
2. Confirm you can log in and open Apps, Settings, and Security.
3. Create one module with pyvelm new <name> and inspect the generated files.

Goal: understand the project layout and install flow.

Day 2: Define your first model

1. Read Declaring models.
2. Generate a model and view skeleton:

pyvelm make:model tasks.todo --module=tasks
pyvelm make:view tasks.todo --module=tasks
pyvelm make:menu --view=todo.list --module=tasks

1. Run migration commands and install the module.

Goal: comfortably create fields, relations, and basic CRUD screens.

Day 3: Build better UIs

1. Read Building UIs and Form UX.
2. Add one list filter/domain and one form section/notebook.
3. Add an embedded relation using One2many on forms.

Goal: move from generated views to intentional UX.

Day 4: Understand module lifecycle

1. Read Modules.
2. Read Migrations.
3. Practice pyvelm db diff, pyvelm db autogen, and pyvelm db migrate.

Goal: ship changes safely with versioned modules.

Day 5: Secure and ship

1. Read Security.
2. Read Deployment.
3. Configure a non-default admin password and verify cron setup.

Goal: understand default security posture and deployment responsibilities.

Day 6+: Pick a specialization

• Product/app track: Workflows, Report Builder, Email composer, File library.
• Platform track: Database layer (v1.0), Shell navigation, White-label branding.
• Framework contributor track: Console commands, Architecture, API reference.

Quick command loop

Use this loop as you iterate:

pyvelm db diff <module>
pyvelm db autogen <module>
pyvelm db migrate

When your editor needs stronger autocomplete and literal checks:

pyvelm make:stubs