diff --git a/src/bootstraparse/__init__.py b/src/bootstraparse/__init__.py index e69de29..fb95d7e 100644 --- a/src/bootstraparse/__init__.py +++ b/src/bootstraparse/__init__.py @@ -0,0 +1,5 @@ +""" +Bootstraparse is a tool to parse a folder and create a website from it. +After installing it with pip, you can use it by running the following command: + bootstraparse +""" diff --git a/src/bootstraparse/modules/__init__.py b/src/bootstraparse/modules/__init__.py index 363b3a8..a8100a0 100644 --- a/src/bootstraparse/modules/__init__.py +++ b/src/bootstraparse/modules/__init__.py @@ -1,3 +1,3 @@ """ The modules in this folder are used to parse the website. -""" \ No newline at end of file +""" diff --git a/src/bootstraparse/modules/config.py b/src/bootstraparse/modules/config.py index b5eef6d..fdc4249 100644 --- a/src/bootstraparse/modules/config.py +++ b/src/bootstraparse/modules/config.py @@ -1,11 +1,11 @@ -# Interprets config files -# The Config will be loaded by the environment at runtime and should be accessed that way -# Usage: -# from bootstraparse.modules.config import ConfigLoader -# config = ConfigLoader([list of config files], extensions=[list of extensions]) -# config['file']['key'] -# The ConfigLoader class has load_from_file and load_from_folder methods and __getitem__ for accessing loaded elements - +"""Interprets config files +The Config will be loaded by the environment at runtime and should be accessed that way +Usage: + from bootstraparse.modules.config import ConfigLoader + config = ConfigLoader([list of config files], extensions=[list of extensions]) + config['file']['key'] +The ConfigLoader class has load_from_file and load_from_folder methods and __getitem__ for accessing loaded elements +""" import os import rich diff --git a/src/bootstraparse/modules/context_mngr.py b/src/bootstraparse/modules/context_mngr.py index 7f1229b..32524dd 100644 --- a/src/bootstraparse/modules/context_mngr.py +++ b/src/bootstraparse/modules/context_mngr.py @@ -1,16 +1,16 @@ -# Interprets where the parser is located and resolves errors -# You're probably here for the ContextManager class. -# Containers have class_name, debug_map and validate methods for debug, -# self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__. -# self.optionals: accessible via __rshift__ (remapped to return self.map[other]()) -# and self.map: accessible via __invert__ (remapped to return self.optionals) -# Usage: -# from bootstraparse.modules.context_mngr import ContextManager -# ctx = ContextManager() -# container = BaseContainer() -# container[number] -> The number element in the content -# "class_insert" >> container[number] -> Get an element from one of the mapped methods - +"""Interprets where the parser is located and resolves errors +You're probably here for the ContextManager class. +Containers have class_name, debug_map and validate methods for debug, + self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__. + self.optionals: accessible via __rshift__ (remapped to return self.map[other]()) + and self.map: accessible via __invert__ (remapped to return self.optionals) +Usage: + from bootstraparse.modules.context_mngr import ContextManager + ctx = ContextManager() + container = BaseContainer() + container[number] -> The number element in the content + "class_insert" >> container[number] -> Get an element from one of the mapped methods +""" from bootstraparse.modules import syntax, error_mngr, export from bootstraparse.modules.error_mngr import MismatchedContainerError, log_exception, log_message, LonelyOptionalError # noqa diff --git a/src/bootstraparse/modules/environment.py b/src/bootstraparse/modules/environment.py index fad2769..7a73667 100644 --- a/src/bootstraparse/modules/environment.py +++ b/src/bootstraparse/modules/environment.py @@ -1,19 +1,19 @@ -# Module for containing super important variables -# Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and -# self.wasInitialised and integrity_check for debug. -# __getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found. -# Usage: -# from bootstraparse.modules.environment import Environment -# env = Environment() -# env.integrity_check() -> Checks if all mandatory parameters are set. -# env["config"] -> returns config object -# env["template"] -> returns template object -# env["export_mngr"] -> returns export manager object -# env["global_path"] -> returns global path ??? -# env["user_path"] -> returns user path ??? -# env["site_path"] -> returns site path -# env["export"] -> returns export object ??? -# env["site_crawler"] -> returns site crawler object +"""Module for containing super important variables +Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and + self.wasInitialised and integrity_check for debug. + __getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found. +Usage: + from bootstraparse.modules.environment import Environment + env = Environment() + env.integrity_check() -> Checks if all mandatory parameters are set. + env["config"] -> returns config object + env["template"] -> returns template object + env["export_mngr"] -> returns export manager object + env["global_path"] -> returns global path ??? + env["user_path"] -> returns user path ??? + env["site_path"] -> returns site path + env["export"] -> returns export object ??? + env["site_crawler"] -> returns site crawler object""" from bootstraparse.modules import error_mngr diff --git a/src/bootstraparse/modules/error_mngr.py b/src/bootstraparse/modules/error_mngr.py index c460ee4..6b166a2 100644 --- a/src/bootstraparse/modules/error_mngr.py +++ b/src/bootstraparse/modules/error_mngr.py @@ -1,12 +1,14 @@ -# Dedicated module for defining and interpreting errors as well as generating error messages -# You're probably here for log_message or log_exception. -# They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") -# There's also a dict_check(dic, *args) that returns true if all args are keys in the dict. -# Usage: -# from bootstraparse.modules.error_mngr import log_message, log_exception -# log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") -# log_exception(Exception("This is an exception"), level="ERROR") -# dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True] +""" +Dedicated module for defining and interpreting errors as well as generating error messages +You're probably here for log_message or log_exception. + They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") +There's also a dict_check(dic, *args) that returns true if all args are keys in the dict. +Usage: + from bootstraparse.modules.error_mngr import log_message, log_exception + log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL") + log_exception(Exception("This is an exception"), level="ERROR") + dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True] +""" import logging import traceback diff --git a/src/bootstraparse/modules/export.py b/src/bootstraparse/modules/export.py index 38f7edc..48c3ed3 100644 --- a/src/bootstraparse/modules/export.py +++ b/src/bootstraparse/modules/export.py @@ -1,10 +1,12 @@ -# Module for final generation of the translated website -# Usage: -# from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse -# rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"}) -# rsp = ExportResponse("start_string", "end_string") -# em = ExportManager(config_file, template_file) -# em(ExportRequest()) -> ExportResponse() +""" +Module for final generation of the translated website +Usage: + from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse + rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"}) + rsp = ExportResponse("start_string", "end_string") + em = ExportManager(config_file, template_file) + em(ExportRequest()) -> ExportResponse() +""" from io import StringIO from bootstraparse.modules import config, pathresolver, error_mngr, context_mngr diff --git a/src/bootstraparse/modules/parser.py b/src/bootstraparse/modules/parser.py index 180065b..3b9f0bc 100644 --- a/src/bootstraparse/modules/parser.py +++ b/src/bootstraparse/modules/parser.py @@ -1,9 +1,10 @@ -# Main parser, gets config files and parses them for the context manager. -# parse_line takes a io and outputs it all as a list of parsed elements -# Usage: -# from bootstraparse.modules.parser import parse_line -# parse_line(io) -> [element, element, element] - +""" +Main parser, gets config files and parses them for the context manager. +parse_line takes a io and outputs it all as a list of parsed elements +Usage: + from bootstraparse.modules.parser import parse_line + parse_line(io) -> [element, element, element] +""" from io import StringIO import bootstraparse.modules.syntax as syntax diff --git a/src/bootstraparse/modules/pathresolver.py b/src/bootstraparse/modules/pathresolver.py index 4ab0914..de42364 100644 --- a/src/bootstraparse/modules/pathresolver.py +++ b/src/bootstraparse/modules/pathresolver.py @@ -1,11 +1,12 @@ -# Module for resolving relative path problems -# PathResolver takes a relative path in the module and outputs the absolute path, -# BoostraPath can deal with relative paths in the installation folder. -# Usage: -# from bootstraparse.modules.pathresolver import PathResolver, b_path -# b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder -# path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given - +""" +Module for resolving relative path problems +PathResolver takes a relative path in the module and outputs the absolute path, +BoostraPath can deal with relative paths in the installation folder. +Usage: + from bootstraparse.modules.pathresolver import PathResolver, b_path + b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder + path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given +""" import os diff --git a/src/bootstraparse/modules/preparser.py b/src/bootstraparse/modules/preparser.py index ad3df05..be0c281 100644 --- a/src/bootstraparse/modules/preparser.py +++ b/src/bootstraparse/modules/preparser.py @@ -1,11 +1,12 @@ -# Module for pre-parsing user files in preparation for the parser -# Usage: -# from bootstraparse.modules.preparser import preparser -# pp = preparser(file, enviroment) -# pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported # noqa -# pp.do_replacements() # replaces all images and shortcuts in the file -# pp.readlines() # returns the lines of ORIGINAL file -# pp.get_all_lines() # returns the lines of the file after replacements and imports +"""Module for pre-parsing user files in preparation for the parser +Usage: + from bootstraparse.modules.preparser import preparser + pp = preparser(file, enviroment) + pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported # noqa + pp.do_replacements() # replaces all images and shortcuts in the file + pp.readlines() # returns the lines of ORIGINAL file + pp.get_all_lines() # returns the lines of the file after replacements and imports + """ import os diff --git a/src/bootstraparse/modules/sitecrawler.py b/src/bootstraparse/modules/sitecrawler.py index 6620475..13b09fc 100644 --- a/src/bootstraparse/modules/sitecrawler.py +++ b/src/bootstraparse/modules/sitecrawler.py @@ -1,4 +1,14 @@ -# Module for file and directories repartition +""" +Module for file and directories repartition +Usage: + from bootstraparse.modules import SiteCrawler + crawler = SiteCrawler(origin_path, dest_path, _env) + crawler.set_all_preparsers() + crawler.copy_unparsable_files() + for element, destination in crawler: + save(preparse_parse(element), destination, _env) +""" + import os import shutil from bootstraparse.modules import pathresolver, preparser, error_mngr, environment, export diff --git a/src/bootstraparse/modules/sitecreator.py b/src/bootstraparse/modules/sitecreator.py index 6bad6e0..8449d4c 100644 --- a/src/bootstraparse/modules/sitecreator.py +++ b/src/bootstraparse/modules/sitecreator.py @@ -1,4 +1,9 @@ -# Module sequencing the successive actions necessary for website building +""" +Module sequencing the successive actions necessary for website building +Usage: + create_website(origin, destination) +""" + import os from bootstraparse.modules import pathresolver, sitecrawler, environment, config, export, parser, context_mngr diff --git a/src/bootstraparse/modules/syntax.py b/src/bootstraparse/modules/syntax.py index d633001..42d3d84 100644 --- a/src/bootstraparse/modules/syntax.py +++ b/src/bootstraparse/modules/syntax.py @@ -10,6 +10,7 @@ # imports.parse_line('string', True) # returns a List of tokens parsed for imports # any_token.create_diagram("filename") # Debugging """ + import os from itertools import zip_longest from collections import namedtuple diff --git a/src/bootstraparse/modules/template_mngr.py b/src/bootstraparse/modules/template_mngr.py index b241949..7635bea 100644 --- a/src/bootstraparse/modules/template_mngr.py +++ b/src/bootstraparse/modules/template_mngr.py @@ -1 +1,3 @@ -# Module for interpreting default or custom templates. +""" +Module for interpreting default or custom templates. +""" diff --git a/src/bootstraparse/modules/tools.py b/src/bootstraparse/modules/tools.py index 7fff692..521e6dd 100644 --- a/src/bootstraparse/modules/tools.py +++ b/src/bootstraparse/modules/tools.py @@ -1,13 +1,13 @@ """ -############################################################################### -# List of tools for testing -############################################################################### -# Usage: -# from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file -# __GLk(n) # Returns a file link n traceback objects back -# __GL() # Returns a line number at current position -# find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number +List of tools for testing +------------------------- +Usage: + from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file + __GLk(n) # Returns a file link n traceback objects back + __GL() # Returns a line number at current position + find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number """ + import inspect import os import re