Go to file
2020-07-19 00:34:10 -06:00
app_skellington two small fixes: bugfix with older python and error ran into with a user program 2020-07-19 00:34:10 -06:00
tests slight rework cfg module, moving file validation and logic into setters. slight improvement on logging and tests 2020-07-18 23:02:44 -06:00
.gitignore First upload to the big WWW. 2020-03-01 21:08:11 -07:00
LICENSE.txt preparing for pypi release 2020-07-19 00:18:00 -06:00
MANIFEST.in preparing for pypi release 2020-07-19 00:18:00 -06:00
README.md referenced ConfigObj documentation links 2020-03-11 23:18:51 -06:00
setup.cfg preparing for pypi release 2020-07-19 00:18:00 -06:00
setup.py preparing for pypi release 2020-07-19 00:18:00 -06:00

app_skellington

Application framework for Python, features include:

  • Pain-free multi-level command menu: Expose public class methods as commands available to user.
  • Simple to define services and automatic dependency injection based on name (with custom invocation as an option). *WIP
  • INI-style config and and validation (provided through ConfigObj).
  • Colored logging (provided through colorlog)
  • Works on Linux, Windows, and Mac.

Principles:

  • Lend to creating beautiful, easy to read and understand code in the application.
  • Minimize coupling of applications to this framework.
  • Compatable with Linux, Windows, and Mac. Try to be compatible as possible otherwise.
  • Try to be compatible with alternate Python runtimes such as PyPy and older python environments. *WIP

Application Configuration

Site configurations are supported through ConfigObj. There is a config.spec in the src directory which is a validation file; it contains the accepted parameter names, types, and limits for configurable options in the application which is built on app_skellington. The format is multi-level .ini syntax.

Reference the ConfigObj documentation for config.ini and config.spec format. See:

Config files (config.ini) are created if they don't exist. The file always contains the full specification of parameters; i.e. even default parameters are added into the config file.

Linux:

/home/<user>/.config/<app_name>/config.ini

/home/<user>/.cache/<app_name>/log/<app_name>.log

Windows:

C:\Users\<user>\<app_name>\Local\<app_name>\config.ini

C:\Users\<user>\<app_name>\Local\<app_name>\Logs\<app_name>.log

Application configuration can be overridden ad-hoc through the --config argument.

Debug - Turn on Logging

Set 'APPSKELLINGTON_ENABLE_LOGGING' environment variable to any value which turns on AppSkellington-level logging. For example,

APP_SKELLINGTON_DEBUG=1 <executable>

or

export APP_SKELLINGTON_DEBUG=1
<executable>

Tests

Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory.

Notes

See official website: https://zavage-software.com Please report bugs, improvements, or feedback!