Rattail – Retail Software Framework

This documentation is for Rattail “proper”, i.e. the core data (etc.) framework on which everything else depends.

Information on applications which are built on top of Rattail may be found at http://rattail.edbob.org/.

Contents:

• Core API
  • rattail Module
    • Attributes
    • Functions
    • Classes
  • rattail.classes Module
    • Functions
    • Meta Classes
    • Data Classes
  • rattail.console Module
    • Classes
  • rattail.db Module
    • Functions
  • rattail.enum Module
    • Enumerations
  • rattail.etl Module
  • rattail.exc Module
  • rattail.ext Module
    • Functions
  • rattail.filters Module
  • rattail.mappers Module
    • SQLAlchemy Mapper Extensions
  • rattail.model Module
  • rattail.perms Module
  • rattail.util Module
• Rattail Extensions
  • Available Extensions
    • members
    • orders
    • purchasing
    • timeclock
  • Creating an Extension
  • Adding Tables
  • Adding Enumerations
  • Adding Classes
  • Altering Class Mappings
  • Adding Permission Definitions
  • Restoring the Framework
• Hacking Rattail
  • Creating a New Release
    • Test/Commit Changes
    • Confirm/Set Version
    • Tag Version
    • Build/Publish Release
    • Updating Package Docs

Documentation To-Do

Todo

Finish the permission extension docs.

(The original entry is located in extensions.txt, line 180.)

Indices and tables

• Index
• Module Index
• Search Page