Welcome | Get started | Dive into Lino | Contribute | Reference

lino.api¶

A series of wrapper modules to encapsulate Lino's core functionalities. They don't define anything on their own but just import things which are commonly used in different contexts.

One module for each of the three startup phases used when writing application code:

The lino.api.ad module (application design) contains classes and functions that are available already before your Lino application gets initialized. You use it to define your overall application structure (in your settings.py files and in the __init__.py files of your plugins).
The lino.api.dd module (database design) is for when you are describing your database schema (in your models.py modules).
The lino.api.rt module (runtime) contains functions and classes which are commonly used "at runtime", i.e. when the Lino application has been initialized.

You may import it at the global namespace of a models.py file, but you can use most of it only when the startup() function has been called.

Recommended usage is to import these modules as follows:

from lino.api import ad, dd, rt, _

Another set of modules defined here are for more technical usage in specialized context:

`doctest`	A selection of names to be used in tested documents.
`shell`	A shortcut import for usage in a Django shell or a `pm run` script.
`selenium`	Defines the `Tour` class and a `runserver()` function.