iommi

Your first pick for a django power cord

iommi is a Django-based framework that magically create pages, forms and tables with advanced out-of-the-box functionality based on your applications models - without sacrificing flexibility and control.

Major features:

• A system to project django model definitions into more high level definitions
• Forms: view models, data validation, and parsing
• Queries: filtering lists/query sets
• Tables: view models for lists/query sets, html tables, and CSV reports
• Pages: compose pages from parts like forms, tables and html fragments

All the components are written with the same philosophy of:

• Everything has a name
• Traversing a namespace is done with __ when . can’t be used in normal python syntax
• Callables for advanced usage, values for the simple cases
• Late binding
• Declarative/programmatic hybrid API
• Prepackaged commonly used patterns (that can still be customized!)
• Single point customization with no boilerplate
• Escape hatches included

See philosophy for explanations of all these.

Example:

class IndexPage(Page):
    title = html.h1('Supernaut')
    welcome_text = 'This is a discography of the best acts in music!'

    artists = Table(auto__model=Artist, page_size=5)
    albums = Table(
        auto__model=Album,
        page_size=5,
    )
    tracks = Table(auto__model=Album, page_size=5)


urlpatterns = [
    path('', IndexPage().as_view()),
]

This creates a page with three separate tables, a header and some text:

For more examples, see the examples project.

Usage

See usage.

Running tests

We use hammett for tests, so pip install hammett then run hammett.

There’s a make test-live target for running tests interactively. You first need to pip install watchdog pyyaml argh.

For running the full tests on all supported environments: install tox then make test-all.

License

BSD

Contents:

• Usage
  • Install
  • Basic usage
  • Production use
  • Under the hood
• Philosophy
  • No silent mistakes
  • Everything has a name
  • Traversing a namespace is done with __ when . can’t be used in normal python syntax
  • Callables for advanced usage, values for the simple cases
  • Late binding
  • Declarative/programmatic hybrid API
  • Prepackaged commonly used patterns (that can still be customized!)
  • Single point customization with no boilerplate
  • Escape hatches included
• Architecture
  • Execution phases
  • Bind
  • Namespace dispatching
  • Evaluate
• Pages
  • Example
  • Page
  • html
  • Part
  • Fragment
• Tables
  • Creating tables from models
  • Explicit tables
  • Table of plain python objects
• Queries
  • Query language
  • Stand alone example
• Forms
  • Declarative forms
  • Programmatic forms
  • Fully automatic forms
  • Post handlers
• Registrations
  • Django custom fields
  • Rendering of your custom types in a table
  • The search fields of your Django models
  • Custom styles
• Admin
  • Installation
  • Customization
• HOWTO
  • General
  • Parts & Pages
  • Forms
  • Tables
  • Queries
• API Reference
  • Action
  • Asset
  • Attrs
  • Cell
  • Column
  • ColumnHeader
  • Container
  • Endpoint
  • Field
  • Filter
  • Form
  • Fragment
  • Header
  • HeaderConfig
  • Members
  • Menu
  • MenuItem
  • Page
  • Part
  • Query
  • Style
  • Table
  • Traversable
• History
  • 2.5.0 (2020-11-19)
  • 2.4.0 (2020-11-04)
  • 2.3.0 (2020-10-30)
  • 2.2.0 (2020-10-16)
  • 2.1.0 (2020-10-07)
  • 2.0.1 (2020-09-22)
  • 2.0.0 (2020-09-22)
  • 1.0.3 (2020-08-24)
  • 1.0.2 (2020-08-21)
  • 1.0.1 (2020-06-24)
  • 1.0.0 (2020-06-10)
  • 0.7.0 (2020-05-22)
  • 0.6.2 (2020-04-22)
  • 0.6.1 (2020-04-21)
  • 0.6.0 (2020-04-17)
  • 0.5.0 (2020-04-01)
  • 0.4.0 (2020-03-30)
• Credits
• Contributing
• @github
• @pypi

Indices and tables

• Index
• Module Index
• Search Page