Skip to main content

A simple web framework with base functionality to build web applications.

Project description

.. image::

Ringo is a small Python based high level web application framework build with
Pyramid. Ringo tries to make it very easy to build form based web application
to manage your data. Because ringo provides many basic features which are
often used in modern webapplications it greatly speeds up development. But it
is also flexible and offers many ways to configure the layout, behaviour and
workflow of your application. See the list of :ref:`features` for more

Ringo comes with an application scaffold which can be used as a boilerplate for
your application development. See the development part in the documentation
for more details on how to build a Ringo based application.

Ringo is Free Software. It is licensed under the GPL license in version 2 or
later. See `<>`_ for more details on the license.

Ringo provides some basic features which are useful if you build your
web application based on Ringo:

* Easy extendible and configurable modular architekture,
* Basic actions for every modul including:
- Search and sortable listing (storeable and configurable)
- Basic CRUD actions
- CSV, JSON import and export
* Role based authorisation.
* Authentication with email registration and password reminders
* Powerfull statemachine to model workflows in moduls.
* Layout and validation of forms using the `Formbar <>`_ library
* Internal messenging system
* Logging of useractions
* Versioning of forms (see what changed to the last version)
* Ready to use modules:
- User Profiles
- Comments
- Tags
- Files
- Basic Appointments
* Widely configurable from the web UI.
* Nice console client for various administration tasks.
* ...

The source of documentation comes with the source of ringo and can be found in the
"docs" folder. To generate the HTML version of the documentation please invoke the
following command::

invoke docs

You need to have the sphinx package installed in order to generate the documentation.
A generated (and maybe outdated) version of the documentation is available on

Getting Started
The fastest way to get an impression of Ringo`s core functionallity is to
start the standalone application of ringo with the following steps:

- $ hg clone

- $ python develop

- $ ringo-admin db init

- $ invoke docs

- $ pserve development.ini

See Ringo tracker on bitbucket for more feature requests!

The following list is only an incomplete reminder. Items here should be moved
to the tracker.

- Send notification mail when a new user registers a new account.
- Send notification mail when a new user confirms the new account.

Refactoring. Cleanup Model and try to get rid of pyramid specific elements
like the request.

* Removed __json__ method. JSON export is now completely handled in the
Exporter (JSONResponse)

* All Mails will have the application name in the subject.
* Add "nolink" Attribute to the DropdownRenderer.
* Added new TagFieldRenderer. Will only show tags which are associated to no
or the items module.


* Translate options in dropdown lists.
* Translate headers in newslist.
* Fixed automatic translation in connection with mappings.
* Handle case if an attribute returns a BaseList as selected items in

* Text in News is now a Textarea.

IMPORTANT: Application will need some work on application initialisation to
stay compatible with this release:

1. rename add_route to setup_modul
2. Move setup of modules into a "includeme" method.
3. Use config.include("appname") to call the includeme method.
4. setup_finished callback is removed.

- Changed the way how the routing is setup on application initialisation. Now
iterate over all available modules from database and configure the routes
for each modul instead hardcoding the configuration including importing the
modules etc.
- Added new ringo-admin command.
- Removed old add-ringo-modul command.
- Automatic logout after a configurable time. Defaults to 1800sec. Some time
before the loggout a warning dialog will be raised.
- Removed deprecated "ignore" filter for selections. Use must use filter now.
- Filter option and items Dropdowns and Listings (Listfield, Comments) on user permissions.
- Changed permission system. Add user roles to the user if the user is member
of the items group. Added group roles additionally.
- Usergroups and Roles now have a description.
- Statemodel of forms only have two states now: Draft, Published
- Added support for Regular expressions in search (again). Now you can
configure if the searchterm is a regular expression or not.
- Show userlisting in roles.
- #47: Added last_login column
- Changed caching. Replaced class based caching partially with request based
caching if possible. Use new Cache object (lib/ for caching in

- Fixes in the overview
* Sorting on BaseItems is done based on their string representation.
* Filter expressions are now escaped. This allows special chars in the
search. Therefor regular expressions are currently not supported
anymore. See #52.
* Search is now case insesnsitive.
- Fix expandation of value in readonly dropdowns.
- New formencode version 0.8.1
- New registed users will have the user role in addition to the user group now.
- Implement formbar translation.

- Update to JQuery to 2.1.1
- Update to Bootstrap 3.1.1
- Changed permission system.
- Add boolean flag to choose if the group roles should be included in the user.get_roles()
- Changed building the principals of the user. Group roles will only be added
to the user if he is actually member of the items group on permission check
- Add option to configure a default group on modul level which will be used on
creation time as group if no special user default group is defined.
- Added information about the users profile to the user form.
- Allow refering to python properties in ListingFieldRenderer.
- Only render link in Dropdownfields if the user is actually allowed to view
or update the linked item.
- Support alternative forms in the update view.
- Fix configuration of default sorting order in tableconfig (Was ignored).
Changed default to asc.
- Add sorting to the ListfieldRenderer based on the tableconfig.
- Show number of items in the header of item overview pages.
- BaseLists are now iterable.
- Add label of the forms modul in the forms overview.

- Added option "not specified" to gender field in profile.
- Improved rendering of dropdownfield. Fixed emtpy field if there is no linked
- Worked on importer. Handle uuid values correct on import.
- Fix deleting profiles if a user is gets deleted.

- Improved Formbar form editing. Use new ACE ( JS based
editor to edit the form definition. Requires new formbar lib (>= 0.7)
- Add preview tabs to the form editor, which allow to see a basic preview
of the form. The preview does not support any dynamic now application
specific renderers.
- Write the formbar specific CSS and JS on application start into the ringo
static folder.
- Do not include the JS and CSS code of formbar into the document. Instead use
to dynamically written CSS and JS files to reduce the size of the generated
- Improved password encryption. Replaced use of pythons built in hashlib.md5
algorithm with the use of the passlib library
( for more secure password.

- Improved export of Blobform items. Instead of exporting the "data" attribute
all field in the data field will be flattend and added to the toplevel of
the export.
- Added Import and Export to the profiles module

- #12: Implemented basic version of bundled actions. Currently "Delete" and
"Export" is supported.
- Modified export. Export now supports exporting more than one item (Bundled

- Added more testcases
- Added new configuration variable "security.enable_csrf_check" in
configuration files.
- Use default excel dialog on CSV export.

- #41: Cleanup of code. Remove init_model function calls, Removed initializedb
script which was used to initialize the database for the application. Now
alembic is used for this.
- Removed default ItemFactories, Removed default __unicode__ functions.
- Added more testcases

- Changed order of calls to add relations, handle events and saving the values
in the item. Prevents errors when inheriting informations from linked items.
- Fixed setting max_age in auth_tkt cookie. Fixes error in IE10 for if running
in pyramid > 1.4.5.
- Changed import. Import now allows importing multiple items. After the import
has finished a result page is shown.
- Implemented import and export as CSV.

- Splitted requirements. Required packages for testing are now installed
- Added unittests to test /lib/helpers
- Added unittests to test /views/index
- Enhanced Profile modul. Added gender field. Make some fields desired and required.
- Added "multiple" attribute to Listfield Renderer. Allows the restrict the
selection of items to one item at once. Only implemented on client side.
- Add support for list elements while accessing a "." separated
attributes in the __getattribute__ method of the BaseItem.
- Add relation from tags to modules to allow modul specifc keywords.
- Add tags to forms.
- Add comments to forms.
- Ported "filter" attribute of selectionfield renderer to the listfield renderer.

- #36: Another try to fix caching problems. This is another approach to
5c152bd which tried to disable the caching at gets lost. (maybe a merge

- Add service under "rest/rule/evaluate" to evaluate rules. Service is used
for client side evaluation of rules in the formulars.
- Provide the user roles as "_roles" value in the form. This value can be used
to model role based rules in the form. Form needs a hidden field which takes
the provided "_roles".
- Removed category from form form and table configuration. It is currently
- Changed rendering of ringo specif dropdown.
- Add option to configure group and owner inhertinace on creating new
instances in the Owned-Mixin.
- Deletion of Items now cascades to Logs, Comments, Versions and nested
- #18: Added some ringo artwork.
- #8: Make documentation available in the application

- Add new requirement of py3o.template library.
- Add Printtemplate modul. Printtemplates are ODT or ODS documents which are
used as templates for generating nice looking documents. On processing the
template placeholders in the template will be replaced by values of the
item. The template can include basic python expressions. E.g to iterate over
- Add Printable Mixin. Inheriting from this mixin will add a print action to
the item.
- Fixes on permission checks. Add button to add new items in listing only if
the user actually has permission to add new items.
- Add "showsearch", "hideadd", "nolinks" attributes to listfield renderer to
enhance configuration of rendering.
- Render permissions of a role as FieldList.
- Add TodolistRenderer. Render todos in the home view.

- Add Versioned mixin. This mixin can be used to store different versions of
an item. On each update of the item the serialized values of the item will
be saved in the version table. The versions are later used to show
differences between the current and a given prior version in the form.
- Add get_values function to the BaseItem to return a dictionary containing
all values of the item. Optionally the items can be serialized (this
is a very simple serialisation).
- Reorganised automatic logging and changing states. The former version was
implemented as update handler in the mixin classes and was based
on the SQLAlchemy "history" functionallity. Unfortunately this history
wasn't as much reliable as expected in some corner cases. The update handler
was removed and changing the states and logging are now implemented directly
in the save method of the item.

- Replaced route_url with route_path.
- Fixed rendering of links in the dropdown renderer. Consider user permission
on link generation (read/update).
- Added options to the Table renderer to configure the responsive behaviour of
table columns. You can now define which columns should be visible on which
screenwidth. Defaults to show only the first column.
- Workded on Formeditor. Implemented selecting a form when creating new
(blobform) items.
- Introduced warnings (formbar 393:bbd7a5192e29). Validate the item on loading
to generate warning.
- Handlers in the statemachine now get the transition as additional parameter.
This is usefull das the transformation gives access to the state,
statemachine and optionally the request.
- Use sorting configuration from table config in DTLists.
- Added paginated DTList.
- Check if the user is still allowed to edit the item after he edited it
(Statechange). If not call alternative read URL.
- Improved performance. Do some caching here and there.

- Added comment modul
- Added tags modul
- Added todo modul
- Added forms module
- Write save method for items like the save method of formbar.
Overwrite the method in Blobforms.
- Overwrite get_attr, get_value method in blobform to handle getting
values from the datafield.
- Think about how to handle multiple forms for one item. Currently
this is hardcoded on itemlevel which form should be used.
- Added UUID field for each BaseItem
- Implement simple Import and Export. Only single items. No relations.
- Added JSON Importer and Exporter
- Added import and export functions in the view for ringo modules
except for the modul modul
- Small layout fixes (flash messages)
- Modules can now be placed in the "user menu" in the top right. Improved
layout of this menu with textual headers.
- Some code cleanup
- Start using "invoke" command for different tasks like testing or building
the documentation.

- Bugfixes for API Change: BaseLists are not initialized with request instead of request.db
- Improved documentation
- Some fixes in the basic scaffold. Improved alembic integration.

- Added log modul
- Added statemachines
- Added simple mechanism to call handlers for certain events in the model.
This is currently used to:
- Update the updated attribute on every change of a item which has the
meta mixin.
- Create a simple log entry on updating or creating a item.
- Worked on caching the result of SQL queries to improbe the performance.
- API Change: BaseLists are not initialized with request instead of request.db
- Added alembic folders to basic scaffold
- Worked on documentation

- Added news modul
- Use "width" from tableconfig also in DTListings.
- Rows in DTLists are now clickable to if the user is allowed to update the
item then the update action will be called on click. Else call the read action.
- Fix URLs for the ReST-Api to match basically the typical URL Schema for CRUD

* GET /items - Retrieves a list of items
* GET /items/12 - Retrieves a specific item
* POST /items - Creates a new item
* PUT /items/12 - Updates item #12
* PATCH /items/12 - Partially updates item #12
* DELETE /items/12 - Deletes #12

Note, that not all actions are actually implemented yet, but for now the url
schema has beed adapted.

- Improved Layout
- Use Bootstrap 3
- Use new formbar lib (bootstrap 3 compatible)
- Optimized space. Removed tabs. Added advanved menu to the context menu for
accessing other content which was formerly placed in tabs.
- Only show links for registering users or password reminders if the mail
system is configured and registering and reminders are enabled in the auth
system. See ini file. Defaults to not enabled.
- Implemented a message library. Currently it is used to generate based on
mako templating and send mails.
- Added option for users to change their password.

- Improved authorisation system. Make building ACL more simple and robust.
- Implemented configurable str representation of items in the modul setting.
- Show the item representation string on every update and read page.
- Added new date related helper functions.
- Delete usersettings too if the user gets deleted.
- Added caching on modules, table and form configs to improve the performance.
- Introduced new "form" GET parameter to optionally change the default
- Listings
- Fixed value expandation in the listings.
- Added option to List to do the sorted on the expanded or raw value.
- ListingFieldRenderer
When using listing in context with Nested Objects to build
hirachies then take care to only show valid items in the list to
prevent building broken hirachies.
- Handle "onlylinked" config var in FieldListRenderer.
- Handle "ignore" config var in FieldListRenderer.

- Fixed user form configuration which leads to an error in password generation
while creating a new user.
- Changed authorisation. Now access to items are also granted if the user is
member of the items group.
- Changed authorisation in Itemlists. Only items are included in the overview
if the user has access to read the item.
- Updated translations (missing translations for file and appointment modul)
- Changed imports of models. Now use specific import_modul function to import
models in the application to be able to import overwritten clazzes in other
- Added CSRF protection on POST request. On every POST request now a special
csrf token is checked. If check fails a Authorisation error is thrown.
- Added tab to change the ownership informatio in update and read forms if
ownership information is available.
- Removed "transform" funtion from lists.
- Added new alembic scripts to initialise the database.

- Bugfixe on File modul initialisation (missing name)
- Added "values" GET param for views. Can be used to prefill forms with given
- Improved rendering of the ListField Renderer. (Added label, Use new "values"

- Added File module

- Added support for alembic for database migrations.

- Added Appointment module
- Added Renderer for a query DataTable Renderer.
- Added Renderer for ListFields. ListFields are Basically listings of related
items in tabular from providing a checkbox to select and deselect items.
Selected items will get linked.
- Added "backurl" GET parameter. This parameter can be used to define a URL
which should be called instead of the default redirect action after create,
update or delete succeeds. The parameter is saved in a session.
- Added more behave tests (now 42% code coverage).

- Added a Ringo specific renderer for dropdown lists which add a small link
next to the label of the dropdownlist.
- Added Behaviour Driven Test infrastructure based on "behave"
- Small bugfixes.

- Added REST-full service. The service is reachable for all modules on the
known url with the prefix "rest". Eg rest/users/list. Using the interface
requires Authorisation and Authentification which needs to be supplied.
- Added "Nested" Mixin class to allow nested items.
- When a form has multiple pages the currently selected page is now saved in
the user session. Needs recent formbar version.
- Use new get_formbar_js method in inject js code needed for formbar. Neededs
recent formbar lib.
- Items with the MetaMixin will have a default created und updated date of
utcnow now.
- #25: Added support for custom renderes. Renderers can now be defined and
provied to the view functions. The renderer must be derived from the Formbar
FieldRenderer) The view functions will give the renderer to the formbar lib.
Need a recent Formbar version (>=0.3.0)

i18n Support:
- User custom extractor from formbar for translation string in XML form
configuration. No need to mark strings in the configurations as
- Removed lingua requirement.
- Added support for translations in the basic scaffold.

- Added a new TableConfig class. This clazz provides an interface to a JSON
file which is used to configure various aspects to the rendering of the
overview tables. This new configuration directive will replace to old
_table_fields configuration attribute.
- #26: Expand values of relations in the overview from form configuration.
- #27: Save current sorting in the session.
- #28: Save sorting together with the search query in the saved searches.

i18n Support:
- #23: I18n Support in renderes. Added more translations.
- Added lingua as requirement. Needed for message extraction for i18n Support
- Marked form configurations as translateable.
- Added support for translating forms. Requires formbar >= 0.2.1
- Added support to translate headers in the overview.

- #19: Login should be in a Popup window


- #15: Implement Search
- Enabled search by clicking on the value in colums.
- Added table to save usersettings (DB change!)
- Enable saving search queries in the usersettings.

- Added dogpile.cache dependency because of caching in sqlalchemy.
- Enabled basic caching of SQL queries.


- Some improvement in Layout. Make header more compact to not waste to much
- Create an empty "forms" dir under views for the basic scaffold. Fixes error
on creating the form.xml files when adding a new modul.
- Improved add_<<app>>_modul command. Fixed modul (re) initialisation. It the
modul initialisation does not happen on recreating again the database.
- Fix get_path function. Path is now relativ to the application (was relativ
to Ringo)
- #10: Add "visible" flag to moduls. Moduls can now be configured in which
menu to display the modul. (DB change!)
- Added new field "clazzpath" to the modul. Needed only internal for dynmic
imports on permission checks. (DB change!)
- Need formbar in version > 0.1 to be able to render selection fields.


- Improved documentation
- Added a simple request history (needed for #7)
- #1: Error on getting roles while authorisation when user is not logged in
- #2: Put some usefull content on the default index page
- #3: Set application title in the page header
- #4: Add version info page
- #5: Add about page
- #6: Add contact page
- #7: Add dialogs for errors (404, 403)
- #9: Cleanup and structure css
- #17: Hide checkboxes in overviews if bundled actions are not enabled
- #20: Fix layout of flash messages
- #21: Complete german translation


First more or less version which includes all basic functionallity.

- Added basic scaffold
- Added "add_modul" command to add boilerplate code for new moduls.


- Basic model initialisation
- Basic page layout
- Added authentification


- Initial version

Project details

Release history Release notifications

History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ringo-0.15.1.tar.gz (1.5 MB) Copy SHA256 hash SHA256 Source None Aug 28, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page