Welcome to Nereid 6.0

Welcome to Nereid’s documentation. This documentation is divided into different parts. We recommend that you get started with Installation and then head over to Quickstart. If you’d rather dive into the internals of Nereid, check out the API Reference documentation.

The main dependencies of Nereid are Flask and Tryton. In addition, Nereid uses Babel for internationalisation, Speak Later for lazy strings and WTForms for form building.

The template engine used is Jinja2 and Flask is built over Werkzeug a WSGI toolkit.These libraries are not documented here. If you want to dive into their documentation, check out the following links:

If this documentation reminds you of Flask documentation, it is not a coincidence, it has been designed so to ease up the learning curve for anyone who knows both Flask and Tryton.

User’s Guide

This part of the documentation, which is mostly prose, begins with some background information about Nereid, then focuses on step-by-step instructions for web development with Nereid.

Familiarity with Tryton is assumed.

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

Additional Notes

Design notes, legal information and changelog are here for the interested.