module documentation

Module sequencing the successive actions necessary for website building Usage:

  • create_website(origin, destination)
Function create_crawler Returns crawler as an object for navigation in the user files. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :param _env: The environment object...
Function create_environment Returns parserEnvironment as an object containing everything needed for app execution. :param origin: The path of the website to be built. :param destination: The destination path of the built website. ...
Function create_website First function called by bparse.py, calls all other modules in the right order. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :type origin: str :type destination: str :return: 0 if everything went well, 1 otherwise.
Function preparse_parse Returns a list of containers from a preparser. :param preparser: The preparser object. :type preparser: parser.Preparser :return: List of containers. :rtype: list
Function save Saves the list of containers in the destination path. :param list_of_containers: The list of containers to be saved. :param destination: The destination path. :param env: The environment object. :type list_of_containers: list :type destination: str :type env: environment...
def create_crawler(origin, destination, _env):

Returns crawler as an object for navigation in the user files. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :param _env: The environment object. :type origin: str :type destination: str :type _env: environment.Environment :return: Crawler object. :rtype: sitecrawler.SiteCrawler

def create_environment(origin, destination):

Returns parserEnvironment as an object containing everything needed for app execution. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :type origin: str :type destination: str :return: Environment object. :rtype: environment.Environment

def create_website(origin, destination):

First function called by bparse.py, calls all other modules in the right order. :param origin: The path of the website to be built. :param destination: The destination path of the built website. :type origin: str :type destination: str :return: 0 if everything went well, 1 otherwise.

def preparse_parse(preparser):

Returns a list of containers from a preparser. :param preparser: The preparser object. :type preparser: parser.Preparser :return: List of containers. :rtype: list

def save(list_of_containers, destination, env):

Saves the list of containers in the destination path. :param list_of_containers: The list of containers to be saved. :param destination: The destination path. :param env: The environment object. :type list_of_containers: list :type destination: str :type env: environment.Environment