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, 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 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 an admin command.

In a document to be tested using doctest you need to call it manually using e.g.:

>>> import lino
>>> lino.startup('my.project.settings')

Above two lines are recommended over the old-style method (the only one only until Django 1.6):

>>> import os
>>> os.environ['DJANGO_SETTINGS_MODULE'] = 'my.project.settings'

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 use the lino.core.plugins.Plugin because it has some additional functionality.

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 central documentation tree of the Lino framework. It is visible on www.lino-framework.org and on lino.readthedocs.io.

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.

Your feedback is welcome. Our community page explains how to contact us.

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 GitHub (which is done automatically by getlino).

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 specs in the Lino book and form an integral part of the project because they also serve for testing purposes.

Lino Noi

Lino Noi is a customizable ticket management and time tracking system to use when time is more than money.

• The central project homepage is http://noi.lino-framework.org

• Technical documentation, including demo projects, API and tested specs see http://www.lino-framework.org/specs/noi

• For introductions and commercial information about Lino Noi please see www.saffre-rumma.net.

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ì

Lino Così is a Lino application for accounting (more).

• This repository is considered an integral part of the Lino framework, which is documented as a whole in the Lino Book.

• We have some end-user documentation in German

• Your feedback is welcome. Our community page explains how to contact us.

• Changes to this repository are listed at https://www.lino-framework.org/changes/index.html

• You can try it yourself in our demo sites

• The central project homepage is http://cosi.lino-framework.org

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

Lino Avanti is a free Lino application used by social workers in East Belgium for helping immigrants with their integration course.

The integration course is a Belgian administrative procedure consisting in an individual mentoring and a series of courses with the goal of helping new residents to acquire the base knowledge about society and social relations in Belgium in order to ease their integration on the territory. Read more about the procedure in Parcours d’intégration des primo-arrivants (French) or Integrationsparcours: Der Einstiegsweg für Migranten (German).

Lino Avanti is being developed by order of Ministerium der Deutschsprachigen Gemeinschaft (Ministery of the German-speaking Community of Belgium).

This is the main module of Lino Avanti.

lib	Plugins for Lino Avanti.

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

Lino Vilma

Lino Vilma is a customizable contact management system for villages.

• The central project homepage is http://vilma.lino-framework.org

• Technical documentation, including demo projects, API and tested specs see http://www.lino-framework.org/specs/vilma

• For introductions and commercial information about Lino Vilma please see www.saffre-rumma.net.

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

Lino Care is for managing a catalog of people who care.

• The central project homepage is http://care.lino-framework.org

• Technical documentation, including demo projects, API and tested specs see http://www.lino-framework.org/specs/care

• For introductions and commercial information about Lino Care please see www.saffre-rumma.net.

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

Lino Tera is a customizable management system for therapeutic centres.

• The central project homepage is http://tera.lino-framework.org

• Functional specification see http://www.lino-framework.org/specs/tera

• There is also a User's Manual in German: online using Sphinx (work in progress) and PDF using LibreOffice (not maintained).

• For introductions and commercial information about Lino Tera please see www.saffre-rumma.net.

This is the main module of Lino Tera.

lib	Plugins specific to Lino Psico.

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

Lino Voga

Lino Voga is a Lino application for managing courses, participants and meeting rooms.

• The central project homepage is http://voga.lino-framework.org

• For introductions and commercial information about Lino Voga please see www.saffre-rumma.net.

• Online demo site at https://voga1e.lino-framework.org and https://voga1r.lino-framework.org

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.)

The commondata packages

• https://github.com/lsaffre/commondata

• https://github.com/lsaffre/commondata-be

• https://github.com/lsaffre/commondata-ee

• https://github.com/lsaffre/commondata-eg