Extra python libraries for scaffolding server scripts.
Project description
extra python modules for server script scaffolding
This is a work in progress. Use at your own risk.
ext_pylib is a group of submodules that are useful scaffolding for other larger projects. I began developing it after noticing how often I was repeating several patterns for server scripts. It works well for building server scripts.
Installing and Including in projects
Installing ext_pylib
$ git clone git@github.com:hbradleyiii/ext_pylib.git
$ cd <project directory>
$ pip install -e .Running Tests
$ cd <project directory>
$ py.testModules
Domain Module
TODO
Files Module
A class to manage and create files. Also includes three mixin classes Parsable, Section, and Template.
Section Mixin
The Section mixin adds methods useful for processing template section files. A section file is a template of a configuration file that only represents a particular section of that file. It begins and ends with a delineator
For example:
## START:SECTION_NAME ##
content here...
## END:SECTION_NAME ##A use case would be how WordPress delineates a particular section of the htaccess file in its root directory with a start line and an end line. This is a section of the full htaccess file and could be managed by a Section mixin.
Template Mixin
The Template mixin adds a method useful for processing a regular template file: apply_using(). It assumes that the file contains placeholder text to be replaced by actual data. The placeholders and actual data are passsed into the method as a dict. The resulting data is returned (presumably to be saved in another file.) #### Parsable Mixin
The Parsable mixin adds a method useful for parsing (presumably) configuration files. It takes a dict of attribute names and regexes to be used. When setup_parsing() is called, a dynamic property is created for getting and setting a value in self.data based on the regex.
Password Module
TODO
Prompt Module
TODO
User Module
TODO
Soli Deo gloria.
