Build and run a simple curses application. (Includes a lot of examples and unused/depracated code)

python -m source

• pyyaml : file parsing and extension for data files
• curses : front end of application
• sqlite : back end of application
• cerberus : data validation tool
• faker: random data generator
• click: used in some files for standalone functionality and argsparsing

• logging : for all debug and normal output statements created at runtime
• functools : used in wrappers class for decorators functionality
• datetime: used in creating date objects for verification of variable dates

• source: app folder

  • main.py: application file that runs the main loop
  • yamlchecker.py: yaml file loader and validation tool (DEPRECATED: now using cerberus for yaml validation)
  • database.py: sqlite3 connection object to execute sql queries during runtime
  • controls.py: holds user interface classes to display model classes
  • models.py: holds classes that represent data objects within the application
  • YamlObjects: holds yaml model data classes for yaml file loading
  • utils.py: various shared methods used in all files within the source folder

• fakedata: random data tools

  • basic.py: random age, money amount
  • name: random male or female names with prefix and suffixes
  • phonenumber: random telephone number generator

• data: folder holding data files used in app. Includes bulk names, validation schemas and example yaml files.

• receipts: folder used to hold exported receipt data objects. Currently holds depracted yaml files. Ongoing task to convert them.

• tests: holds test data to run failure tests.

  • singlefail: holds test which fail in yamlchecker

• old: holds depracated widget classes. May be used later on so not yet deleted.

• example: Old applications based on old code. Holds examples like tabs, color, and mouse clicking

The project will be broken down into several portions which may be revisited if need be:

• Command line argument parsing to set configuration settings before app is run
• Window classes (Views) are used to give the screen structure and display information requested from controllers. They also handle their own internal key handlers and send update events to other windows.
• Controllers hold connections to database files using sqlite as well as specific methods for data reading and writing. They are responsible for transforming database records into premade models for usage by the window classes in the application.
• Models are used to hold the data retrieved from the database during data retrieval or test data from test functions.