Rattail

Welcome to the Rattail project.

The documentation you are currently reading is for the Rattail core Python package. Some additional information is available on the website. Clearly not everything is documented yet. Below you can see what has received some attention thus far.

Narrative Documentation:

• Email Notifications
  • From Code
  • Configuration
    • Meta Configuration
    • Generic Configuration
    • Specific Configuration
• File Monitor
  • Why?
  • Configuration
    • The “rattail.filemon” Section
    • The “monitor” Option
    • The Profile “dirs” Option
    • The Profile “watch_locks” Option
    • The Profile “process_existing” Option
    • The Profile “stop_on_error” Option
    • The Profile “actions” Option
    • The Profile Action “func” Option
    • The Profile Action “class” Option
    • The Profile Action “args” Option
    • The Profile Action “kwarg” Option(s)
    • The Profile Action “retry” Options
• Data Batches
  • Data Model
  • Handler
  • Using the Batch

Package API:

• rattail
• rattail.csvutil
• rattail.db.batch
• rattail.db.batch.vendorcatalog
• rattail.db.batch.vendorinvoice
• rattail.db.changes
• rattail.db.model
• rattail.db.util
• rattail.enum
• rattail.exceptions
• rattail.filemon
• rattail.filemon.actions
• rattail.filemon.config
• rattail.filemon.linux
• rattail.filemon.util
• rattail.filemon.win32
• rattail.files
• rattail.logging
• rattail.mail
• rattail.time

Documentation To-Do

Todo

Need to explain current limitations of SMTP authentication.

(The original entry is located in /home/sacfoodcoop.com/ledgar/src/rattail/docs/narr/email.rst, line 70.)

Todo

Need to properly explain email template path setting.

(The original entry is located in /home/sacfoodcoop.com/ledgar/src/rattail/docs/narr/email.rst, line 73.)

Indices and tables

• Index
• Module Index
• Search Page