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 web applications 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 architecture,
* Basic actions for every module 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 modules.
* Layout and validation of forms using the `Formbar <>`_ library
* Versioning of forms (see what changed to the last version)
* Widely configurable from the web UI.
* Nice console client for various administration tasks.
* ...

To start the testsuite invoke the following command::

py.test --app-config test.ini

Or with display of the coverage of the tests::

py.test --cov=ringo --app-config

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 version of the documentation is available on

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

- $ git clone

- $ python develop

- $ ringo-admin db init

- $ invoke docs

- $ pserve development.ini

- Rewrite of the documentation.
- Fixed issue21 ( Enabled
sorting config in Listingfieldrenderer.
- Expand values from checkboxes too.
- Added XLSX Export.
- Introduced special suffix `__e_x_p_a_n_d` for attributes which can be used to
access the expanded value of the attribute as alternative to the call of
get_value. This is needed because it is not always possible to call the
get_value method. Example: getattr(obj, 'foo__e_x_p_a_n_d') will return the
expanded value of the `foo` attribute.
- Removed ODF-Converter from Ringo core. It is now part of the
ringo_printtemplate extensions as this is the only place where it is
actually used.
- #5 Show info dialog on circualr dependency error on deletion
- #11 Check uniqueness of name when on creating and update of roles.
- #12 With fix for #5 the admin user can not delete himself anymore, because
of handling of circular dependency.
- #14 Make name field of modules readonly. Field is internal and not meant to
be editable.
- #19 Fixed removing permissions (in general fixed removing items from
- Added "button" layout for the Statefieldrenderer.
- Handle "Save and proceed" button (New feature in formbar).
- Added StaticListRenderer. Can be used to render simple static overviews of
- On user registration the password strength is now checked. Password must be
at least 12 chars long und need to have 2 non chars.
- Add option to define rolespecific descriptions of the state.
- Add option to configure a callback after a user has authenticated with the
application. This callback can be used to cancel the authentification or to
further actions after the user logs in.
- Added sorting icons for datatables.

Bugfix release. Fixes serious problem handling addrelations based on the
session variable. This error may cause wrong relations between items.

- Fixes in scaffold. Improve default MANIFEST and include more files. Make
- Internal UUID field is now 36 chars long. UUID is now stored as defined in
RFC4122. Please note that existing UUIDs are not converted. You can convert
exitsing UUIDs by using the "ringo-admin db resetuuid" command.
- Fixed #19 (
- Let users delete their own account. You can define the behavior to items
defined by the user by setting the _owner_cascades class variable with in
the models to e.g configure to delete all items which are owned by the item
to. On default users can only delete their account if the do now own any
items anymore.
- Implemented "roles" config variable for columns in table configs. If
defined columns are only visible to users who have one of the
configured roles.
- Added "target" attribute to the Linkfieldrenderer.

- Be more tolerant in imports. Only log in case the import includes fields
which are not part of the model.
- Added config varibables to define default roles and groups on user
- Added config variable "layout.show_contextmenu" to configure the visibility
of the context menu.
- Improve result page after a user register a new user account.
- Improve result page after a user request a passwort reset.

- Small performance improvement. Added option to enable caching of the
form configuration. This will prevent the application to reload the
configuration on every request which is expensive. This is usefull for
production envirionments as the form will not change here. However it is not
recomended in development mode.
Please refer to the documentation to see how to enable form caching.
- Fixed reraising exception withing general_exception view. Further only use
this view in testing mode.
- Render title tooltips in table header of overviews
- Make registration and activation of users over the webinterface work again. This means
new user can register themself using the webinterface if registration is
- Added scaffolds to the file. Has been missing.
- Fixed bug which causes exceptions in testcases because new created and
loaded items in different Sqlachemy sessions. Use current db session from
request when invoking the load method of a factory to enforce all items are
attached to the same session.
- Added external requirements.txt file for scaffolds.
- Support DATABASE_URL envirionment variable. If set than this variable will
be used to connect to the database. Eg: postgres://@/ringo


- Reraise origin exception (including stacktrace) in case of errors in global
error view to allow better debugging of errors. The origin stackstrace was
hidden since the last version which introduces a global error view. This
error view hides the origin traceback.

- Tests are now based on pytest. Removed tests based on the package "behave".
Ringo now requires a package pytest-ringo which provides some helper classes
to make testing more easy. Further the tests now support rollbacks.
- Changed behaviour how Ringo extensions are registered on application
startup. Ringo now only shows a short warning on application start if a new
added or removed extension is detected. It does not ask the user if ringo
should register the extension automatically anymore which make the startup
more robust on servers with no active terminal (e.g starting as WSGI).
Adding or removing extensions in normale usage should be added or removed by
migration scripts.
- Added "ringo-admin app add-extension|remove-extension" command to add
or remove the initial modul and action entries during development.
- Improved documentation on how to add extensions in the application.

- Show info dialog at the top to the form in case the validation fails.
This info has been added because users reported data loss because of
formbar/ringo default behaviour of not saving anything in case of
errors. Users seems to expect that the valid part of the data has been
saved. This info should make the user aware of the fact that nothing
has been saved in case of errors


- Only log validation errors in DEBUG loglevel.
- Fixed changed field names in user registration.
- Fixed test cases


- Fixed bug (Introduced with 1.10.2) when encoding values in GET params. Ringo
uses a special notation for encoding values in the URL as GET param in the
`values` key. This method failed for values containing non ASCII values.

Maintenance and Bugfixrelease

- Cleanup after move to Github:
- Removed .coveragerc. Not using coverage at the moment.
- Removed .hgflow. Not using the hg anymore
- Removed .hgignore. Not using the hg anymore
- Removed .tx. Currently not using Transifex for translations.
- Changed links in Documentation and README to refer to Github now.
- Do not log that we are calling get_current_request. This is a long standing
design flaw in Ringo but it does not cause any known problems yet and it is
unlikly to change in the near future. So i replaced the logging with a
"fixme" comment.
- Log "errors" while resolving dot separated values in lists only in the debug
log (was error) in _resolve_attribute. As this might be a sign of an
missconfiguration it is actually handled in the function so we do not log an
error message but give a hint in in the logging in development.
- Log failing CSRF token checks as warning.
- Using encode_values to encode the value for the values attribut in GET
params now returns a urlencoded value. This results in the values will be
double encoded. Added decode_values helper method which can decode
urlencoded values back into a python dictionary. WARNING: If you are using
the values GET param in your application, than you may want to adapt your
- Added/Improved authentification check in setstanding and changepassword
method by adding missing checks and more comments.
- Make fields for the profile while user creation a logical field which is not
stored in the datamodel. This prevents warning messages.
- Make field 'retype_password' a logical field which is not stored in the
datamodel. This prevents warning messages


- Updated translations.
- Fixed bug that set the display variable wrong (uses str_repr instead) when
registering a extension.
- Added compatibility mode regading Ringos behaviour on adding "s" to the
modul names when registering modules. The name of the modul of the extension
is defined in the extension itself and should be taken as it is on default.
However. Ringo tries also load the modul by adding an "s" to be compatible
with older versions.
- Changed warning message on application startup when Ringo notices that there
is a extenstion which needs to be registered. Fixed showing name of the
- Fix scaffold for extensions. Handle case that the user cancel the automatic
registering of the modul.
- Refactored the importer code in ringo/scripts/ and make the code better
reusable for other commands.

* The behavior of overviews using the Datatable JS library can now be
configured with the JSON table configurations too. Formerly only the columns
can be configured. Now other aspects like, filtering, sorting, paginating
etc. You can also define your own custom filters.

The configuration will be generated on the fly based on the JSON config when
rendering the overview. This generated configuration will replace the static
predefined datatable configurations found in the init.js.

* Added datatable-moment.js plugin to allow sorting datatable tables based on


- Fix internal list renderer and handle case if current user has no
permissions at all. Then no links will be rendered.
- Fix has_role method. Handle case if current user is None.

- Log login attemps. Each successfull or failed login will now be saved in a
table called "user_logins".
- Show info on last successful and last failed login on the index page of the
application. Additionally show a warning if there have been more than 5
failed logins since the last successful login.
This feature need to be enabled in the ini file. See documentation for more

- Implemented session timer widget. The widget shows the remaining time in the
session before the autologout will be triggered.
The widget needs to be enabled in the .ini file. See documentation for more
- Dogpile caching for SQL need to be enabled explicit now.
- Enhanced breadcrum feature. Allow to define additional actions which should
be displayed in the breadcrumbs beside the default actions.
- Changed Mailer. The Subject of the Mails do not include a prepended name of the
application anymore.

- Ringo no longer does automatic extension registering on server
startup. Registering a new extension often will write changes to the
database. This is dangerous as this will potentially lead into
failing later migrations. So Ringo will now ask the user what to do on
server start. Default is to abort the registration.
- Added JQuery UI library. This library is currently not used by ringo itself
but it provides basic functionality to other applications.
- Added breadcrumbs feature to Ringo. To be able to use the breadcrumbs you
need to define a sitetree (See lib/ for more details.) The
default sitetree of ringo is empty which means no breadcrumbs are shown.
- Added "--format" flag for the "ringo-admin db loaddata" command to define
the format of the inputfile. It is now possible to use the CSV importer

- Add functionallity for users so set their standin. Basically this is adding
and removing other users to the default group of the user. To use this
feature the user needs at least read access to the users he wants to set as
- Changes favicon format to "ico" to be more compatible with versions of IE.
Improved overwriting of the favicon. The code for favicons are now placed in
favicons.mako which can be overwritten by other applications.
- Fixed handling of bundled delete requests. Two things has been changed:
1. Call the callback before actually deleting it to allow some cleanup.
2. Put the flush of the db operations at the end of the method to
avoid "Closed connection" errors which happens for bundled delete
request after the session has been flushed for the first item.

- Added new configuration variable 'app.mode' to be able to run the
application in a different mode. If set the application will give some
visual indication the the application is in a different mode.
- Changed default rendering of overview pages. Instead of using a
complex overview with advanced search filters e.g Ringo now uses a
simplified overview on default. The behaviour can be changed by either
setting a global `layout.advanced_oveview` configuration varible in
the ini file or per table configuration in the json config of the
table. In the simplified overview features like pagination are currently disabled
regardless what is configured in the table configuration. This may change in
future versions.
- Changed click behaviour in overview tables. Rows are now clickable. With the
change to the simplified overview code the way to select items from the
overview changed also. Links has been removed completely now. Instead the
whole row is clickable.

- Dropped SQLite support because of missing support of data migrations using
alembic. Postgresql is the new default for the DMBS system.
Added psycopg2 as requirement. Actually Sqlite support was broken since
version 1.2.
- Removed fixtures for initial data. Data is now added to the migration
- Added new "--format" flag for the "db savadata" command to determine the
export format. Default is JSON.

- Added new configuration varibale (auth.timeout_warning) to configure how
many secods before the autologout happens a warning will be shown.

- BaseFactory now take an optional argument for a request.
- The callback parameter in the views can now take a list of callbacks too.
The handle_callback method is able to handle this correct. Please note that
this mechanism needs some effort of the developer to build this list in the
view function.
- Add additional callback parameter to the create view of users. This allows
other views to overwrite the user create view and add custom callbacks.

- Fixed circular dependency error on migration using alembic after adding
uid and gid fields for users and usergroups which where self referencing.

Beside the major changes which are listed below this version include many
small bugfixes and improvements in the code, usability and performance.

- Add option to provide external validators to the update and create view.
They will be used for additional validation of the form.
- Implemented a simple Warning Dialog if the user leaves of form without
saving the changed data first.
- Added simple spinner which pops up if the loading of the page takes longer
than 400ms.
- Added new "ringo-admin app init" command to initalise a folder containing
a initial config file.
- Password must be at least 12 chars long and include 2 non-letters.
- Added support for loading configurations in case of multi-derived
applications. Added new app.base configuration variable.
- Added new helper command to copie the static files of formbar into to
correct location in ringo.
- Added option to name the authentification cookie. Needed if there are more
than one ringo application on a server.
- Added a warning dialog which shows if the user leaves a form without saving
it before.
- Do permission checks on submitted values for relations on POST requests.
Users are not allowed to set items in relations for which they do not have
read permissions.
- Log changes of uid and gid.

- Enabled Mako default HTML escaping for Template rendering globally in ini
file and explicit for form rendering, dialog rendering and listing
rendering. Excluded html escaping for messages and the admin scripts as the
rendered result is not aimed to be displayed in a browser.
- Seperated requirements for testing, installation etc.
- Static files from formbar are only copied on application start if there are
not already the formbar files located in ringo. (Need some work). See
"formbar_static" command.
- Fixed typos in german translation.
- Changed behavior of the warning for a nearing auto logout. Instead of
showing after 95% of the logout time is up it will now be shown 3 Minutes
before the actual logout happens.
- The modules for Roles, Users and Usergroups are now inherited from the
"Owned" mixin class.
- Changed setting the GID for new items. Changed order of determining
the GID (inverse order). First try to get the default_gid from the
modul. If not present use the default_gid from the user. Of no
default_gid is set at all leave the GID of the new item blank.

- Removed group role feature. This feature was only rarly used.
- app.url configuration variable which was intended to use in scenarios where
the application is not hosted under the root of the server. See
documentation for deployment for more information on how to setup the
application now.
- Static files of formbar are no longer copied into the static files of ringo
on application start. These files are now dynamically loaded from formbar.
- Invoke command "formbar_static"

- Added "openmodal" option to LinkfieldRenderer
- Added "action" option to LinkfieldRenderer to be able to render other
actions then read and update links.
- Added _get_permission classmethod in the Baseitem class. This class can be
overwritten to implement a custom way to build the ACL for this class and
- Added info page after login if the account has been disabled.
- Added --path option to load and save fixtures to be able to load alternative
- Implement setting dot-separated values in items.
- Implemented fuzzy search. The search now supports the "~" operator to
trigger a fuzzy search which uses the doublemetaphon as primary algorithm
and falls back to the levenshtein algorithm as secondary it the primary

- Only show "Homepage" on index page if the user is actually logged in.
- Fixed DTListRenderer which was only rarly used and seems to be broken for
some time. The fix onyl gets it working again. There is still work to do to
make it work as the default ListRenderer (Display of Link e.g).
- Allow custom title and body in confirmation dialog.
- Use form parameter when getting the create form. Usefull when you want to
use an alternative form to create an item.
- Hide attribute of ActionItems also affects overview lists.
- "ringo-admin modul add" command does not generate SQL code anymore. Instead
of this it will print out code for the fixtures.
- Make the application base url configurable using the app.url config
- Added title tooltips in context menu
- Only save paths in the history and not full qualified URLs.

WARNING! This update is a major upgrade of Ringo which may break your application!
It removes many of the core modules in the application! This will break your
application if you use one of the removed modules. In this case stay with the
0.18.0 version.

The following modules has been removed:

- Removed Log module
- Removed Tags module
- Removed Printtemplate module
- Removed Appointment module
- Removed Comments module
- Removed File module
- Removed News module
- Removed Todo module

The modules will be converted into extensions.

With version 0.16.2 Ringo supports loading extensions to enhance the
functionality of the application. This should be the default way to add
optional features to a Ringo based application. Since the removed modules all
implement general features which are optional to your application and aren't a
basic requirement, they has been removed from the core now. This reduces the
code base and make the core faster and more secure. The later is an important
precondition for post 1.0 goal: Getting much more secure to get ready to build
rock solid web application in Ringo.

- Added Label field to the roles module.
- Added new "fixture" command in ringo-admin to load and save fixtures.
- Added new "revision" db command in ringo admin to generate a new
(autogenerated) alembic migration script.
- Added fixtures for initial data.
- Support german locale in datefields. (Requires new formbar)
- Added showall option for Listfieldrenderer to show all elements regardless
if the user is allowed to read the item. If the user is not allowed to read
the item no link to open the item will be rendererd.
- When creating a new user a usergroup for the new user will be generatated
automatically. The new usergroup will be set as default usergroup for the
new user if no other group is set while creation.

- The documentation is now opened in a new browser window instead of opening
it in a modal popup window.
- Modal dialogs can not be closed by clicking in the background.
- Reimplemented openmodal function in listingfields. Has been removed by
- Changed behaviour of the onlylinked attribute in listingfields. Also removes
the checkboxes now as there is no reason to link/unlink items if only the
linked items should be displayed.
- Improved user language detection in Javascript. Language setting is now
determined by calling a remote function in the Rest API.
- The create method of factories now require a values attribute! It is not
optional but can be empty to get the old behaviour.
- Show

- Pre 1.0 Migration scripts removed. The older migrations scripts are now
replaced by one single script. The alembic version of this version is still
the same so that future migration scripts can be applied to old applications
as well.

- Added option to open items in a modal window.
- Show spinner when opening items in a modal window.
- Set requirment of formbar to >= 0.9.4.
- Added 'url_prefix' and 'url_scheme' the server configuration in the template
of the ini file in base scaffold. This is usefull if the server is running
behind a reverse proxy.
- Added options to configure the startup of the ODFConverter. On default the
converter is not started! This is a change to the previous behaviour!
- Loading data in ringo-admin command can optinally be done by using the ID of
the item instead of the default UUID. This is usefull for initially loading
data after creating a database in case not all entries in the database have
- Add support for import and and export of NM-relations. (Experimental). To
enable this feature simply add the --include-relations to the savedata
- Improved translations. Added missing calls to translate function at various
- Added experimental support for exanding values for dotted attributes (e.g
- #77 Support alembic >= 0.7.1
This will detect missing foreign keys in your datatable.
* Please update to a recent version of alembic (currently 0.7.4)
* In case you are using SQLite: Merge
ringo/alembic/versions/ migration script to your migration
scripts and apply it. See for more details on
merging. This will fix errors in the base ringo model.
* Please generate a new migration and apply it. If your missing any foreign
keys they will be generated now. If you are using SQLite please refer to
ringo/alembic/versions/ and see how migration is done for
the base tables.
- #87 Remove alembic_sqlite dependeny.
As alembic now supports some missing operations like add and drop column on
SQLite the helper library alembic_sqlite is not needed anymore.
* Please search for the string "drop_column_default" and remove this and the
following codeblock from your existing migration files.

- Added configuration for transifex
- Fixed error when opening News items.
- Init the form with the correct eval_url. Provide url_prefix when
initialising the form.
- Show hint on errors in formdefinition in formeditor.
- #37: Further fixes.
- #86: Fixed extension specific view mapping.

- Improved overview and searching.
- Added clientsided pageination function.
- Added option to add a operators (<, <=, =>, >, ==, !=) to the
search. If the user has provided a opertors the search will use this
operator to do the search instead of a search based on a regular
expression. This is usefull for searches on dates.
- Improved exporting.
- Added RecursiveRelation Exporter.
- Added ODF Converter.
- Insert scaffold of a formdefinition when creating a new form.
- Added support for translations in extensions.
- Status messages are now rendered at the top of the page.
- Added option to set a custom header with logo above the navbar more easily.
- #37: Change ownership only for admins
- #48: Add support to drop columns in SQLite.
- #50: Change behavior of "click-seaerch-filter" in overviews
- #64: Better indication of current edit mode
- #67: No ISE on reading data from the import file. Show error dialog now.
- #68: Installation/Setup fails because of missing files
- #82: Migration of the database for the first module sometimes does not work
- #85: News can't be marked as read

- Important: Changed the way how the DBSession is setup. See ringo/
file how it is setup now and adapt you application.
- Added commands to generate SQL to restrict and unrestrict access to table of
a modul on database level (only postgres)
- Fixes of loading Form and Overview configuration.
- Add escaping into the renderer

- Add function to load ringo extenstions.
- Changed logging in application (Removed and modified)

- Allow configuration of caching of pages and static content.
- Add various option to enhance cookie and session security.
- Set headers to enhance security according to

Refactoring of views:
* Seperation of views: Basic views (LCRUDIE) are now located under
views.base.list ... views.base.export. Removed views/
* Moved REST logic into the corresponding new view modules.
* Moved methods and code from views.json into the new views.api and
views.response modules
* views.api: Modul with method used by the client.
* views.respose: Modul with special Response objects.
* views.request: Modul with methods (handlers) with common logic for various views.
* views.helpers : Modul with helpers methods (getters) to get things like to forms or
information from the request.

Refactoring of model:
* Removal of the request dependecy in the base model.
Refactoring of the setup of the modules.
* Removal of several class methods like get_action_routename and get_item
actions into lib.helpers and others.

Refactoring of lib:
* Splitted large lib/ into various files under lib/helpers.
* Splitted large lib/ into various files under lib/renderer.

HOWTO Upgrade:

* The following methods has been moved:
- get_table_config -> lib/
- get_form_config -> lib/
- get_action_routename -> lib/
- get_item_list -> model/
- get_item_modul -> lib/

Search for these methods in all *.py and *.mako files and adapt the call.

* Use app title instead of app name as prefix in subject of notification mails.
* Fix urls in import, export dialogs. Use get_current_route_patch instead of
URL (causes errors with SSL behind an reverse proxy)
* Fix import. Handle NULL values correct for integers.
* Fix handling NULL values in sorting.
* Use new formbar version 0.9.0. Fix some rules.

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

Download files

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

Source Distribution

ringo-1.14.0.tar.gz (1.1 MB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page