Welcome to Nereid

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 the Quickstart. Besides the quickstart, there is also a more detailed Tutorial that shows how to create a complete (albeit small) application with Nereid. 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, WTForms for form building and ccy for currency mapping.

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.

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.

About Nereid

Nereid is a webdevelopment framework for Python based on Tryton. You are currently looking at the documentation.

Other Formats

You can download the documentation in other formats as well:

Useful Links

This Page