Metadata-Version: 2.4
Name: iommi
Version: 7.18.1
Summary: iommi is a high level framework built on django
Home-page: https://github.com/iommirocks/iommi
Author: Anders Hovmöller
Author-email: boxed@killingar.net
License: BSD
Keywords: iommi
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: Django>=3.2
Requires-Dist: pyparsing
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

iommi
=====

.. image:: https://img.shields.io/badge/Code_on-GitHub-black
    :target: https://github.com/iommirocks/iommi

.. image:: https://img.shields.io/discord/773470009795018763?logo=discord&logoColor=fff?label=Discord&color=7389d8
    :target: https://discord.gg/ZyYRYhf7Pd

.. image:: https://github.com/iommirocks/iommi/workflows/tests/badge.svg
    :target: https://github.com/iommirocks/iommi/actions?query=workflow%3Atests+branch%3Amaster

.. image:: https://codecov.io/gh/iommirocks/iommi/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/iommirocks/iommi

.. image:: https://readthedocs.org/projects/iommi/badge/?version=latest
    :target: https://docs.iommi.rocks
    :alt: Documentation Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

iommi is a toolkit to build web apps faster. It's built on Django but goes a lot further.

It has:

- `forms <https://docs.iommi.rocks//forms.html>`_: that feel familiar, but can handle growing complexity better than Django's forms
- `tables <https://docs.iommi.rocks//tables.html>`_: that are powerful out of the box and scale up to arbitrary complexity
- a system to `compose parts <https://docs.iommi.rocks//pages.html>`_:, like forms, menus, and tables, into bigger pages
- tools that will speed up your development like live edit, jump to code, great feedback for missing select/prefetch related, a profiler, and more.
- great error messages when you make a mistake

.. image:: docs/README-demo.gif


Example:


.. code-block:: python

    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:

.. image:: docs/README-screenshot.png

For more examples, see the `examples project <https://github.com/iommirocks/iommi/tree/master/examples/examples>`_.


Getting started
---------------

See `getting started <https://docs.iommi.rocks//getting_started.html>`_.


Running tests
-------------

You need to have tox installed, then:

.. code-block::

    make venv
    source venv/bin/activate
    make test
    make test-docs


License
-------

BSD


Documentation
-------------

https://docs.iommi.rocks
