API

This section has been automatically generated from the source code.

The lino package

The lino package is the main plugin used by all Lino applications, and the root for the subpackages that define core functionalites.

As a plugin it is added automatically to your INSTALLED_APPS. It defines no models, some template files, a series of django-admin commands, the core translation messages and the core help_texts.py file.

core

Contains Lino's core functionalities.

hello

If you want to see which version of Lino you have, you can say "hello" to Lino:

api

A series of wrapper modules to encapsulate Lino's core functionalities.

utils

lino.utils (the top-level module) contains a few often-used function for general use.

mixins

This package contains model mixins, some of which are heavily used by applications and the Lino Extensions Library.

projects

Most of this package has been moved to lino_book.

modlib

The standard model library included with Lino.

sphinxcontrib

Some extensions for Sphinx.

management.commands

See The django-admin commands added by the lino plugin.

(This module's source code is available here.)

lino.startup(settings_module=None)

Start up Django and Lino.

Optional settings_module is the name of a Django settings module. If this is specified, set the DJANGO_SETTINGS_MODULE environment variable.

This is called automatically when a process is invoked by a django-admin command.

This is usually called in the initialization code snippet of a tested document.

class lino.AppConfig(app_name, app_module)

Bases: django.apps.config.AppConfig

This is the only django.apps.AppConfig object used by Lino. Lino applications instead use the lino.core.plugins.Plugin class to define plugins. See Introduction to plugins.

The lino_xl package

This package contains the code of the Lino Extensions Library.

See Plugins of the Extensions Library for the list of plugins.

lib

These are the plugins included with Lino XL.

(This module's source code is available here.)

The lino_react package

react

A user interface for Lino applications that uses FaceBooks React JS framework.

(This module's source code is available here.)

The lino_book package

This is the code repository that contains (1) the Sphinx source files of the Lino Book, (2) the lino_book Python package and (3) a test suite with doctest-based tests for the Lino framework.

The Lino Book is the technical documentation tree of the Lino framework. It is visible on https://www.lino-framework.org.

The lino_book Python package is a collection of small example Lino applications used for educational and testing purposes.

The code repositories for the lino and lino_xl Python packages have no documentation tree on their own and almost no unit tests, they are tested and documented here.

The lino_book package contains a set of example projects used both for testing and explaining Lino framework.

It is not published on PyPI because that would make no sense. You use it by cloning the repository from GitLab (which is done automatically by getlino configure with --devtools).

projects

This package contains example applications included with the Lino book.

(This module's source code is available here.)

Lino applications covered by the book

The following Lino applications have their developer specs and API in the Lino book and form an integral part of the Lino core because they also serve for testing purposes.

Lino Noi

This is the main module of Lino Noi.

lib

Extended and specific plugins for Lino Noi.

(This module's source code is available here.)

Lino Così

lib

Plugins

migrate

This is a real-world example of how the application developer can provide automatic data migrations for Python dumps.

(This module's source code is available here.)

Lino Avanti

This is the main module of Lino Avanti.

lib

Plugins for Lino Avanti.

(This module's source code is available here.)

Lino Vilma

This is the main module of Lino Vilma.

lib

Extended and specific plugins for Lino Noi.

(This module's source code is available here.)

Lino Care

This is the main module of Lino Care.

lib

Extended and specific plugins for Lino Care.

(This module's source code is available here.)

Lino Tera

This is the main module of Lino Tera.

lib

Plugins specific to Lino Psico.

(This module's source code is available here.)

Lino Voga

The main module of Lino Voga.

lib

This package contains apps which are specific to Lino Voga.

(This module's source code is available here.)