Metadata-Version: 1.1
Name: ext_pylib
Version: 0.1
Summary: Extra python libraries for scaffolding server scripts.
Home-page: https://github.com/hbradleyiii/ext_pylib
Author: Harold Bradley III
Author-email: harold@bradleystudio.net
License: MIT License
Download-URL: https://github.com/hbradleyiii/ext_pylib/archive/0.1.tar.gz
Description: ext_pylib
        #########
        extra python modules for server script scaffolding
        ==================================================
        
        .. image:: https://travis-ci.org/hbradleyiii/ext_pylib.svg?branch=master
            :target: https://travis-ci.org/hbradleyiii/ext_pylib
        
        .. image:: https://www.quantifiedcode.com/api/v1/project/b9f8a6c7f3724ee4896e7cd8d2a865aa/badge.svg
            :target: https://www.quantifiedcode.com/app/project/b9f8a6c7f3724ee4896e7cd8d2a865aa :alt: Code issues
        
        ----
        
        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
        --------------------
        
        .. code:: bash
        
            $ git clone git@github.com:hbradleyiii/ext_pylib.git
            $ cd <project directory>
            $ pip install -e .
        
        Running Tests
        -------------
        
        .. code:: bash
        
            $ cd <project directory>
            $ py.test
        
        Modules
        =======
        
        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:
        
        .. code:: bash
        
            ## 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.
        
Keywords: server development,files,domain names
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
