From 013c3d74655d888015504c97ec7be16b2b5619bb Mon Sep 17 00:00:00 2001 From: vky Date: Sun, 23 Jan 2022 22:39:10 +0100 Subject: [PATCH] added skeleton for the project structure --- .github/workflows/configs/parser_config.yml | 0 README.md | 2 ++ bparse.py | 1 + example_userfiles/config/aliases.yml | 0 example_userfiles/config/glossary.yml | 0 example_userfiles/config/website.yml | 0 example_userfiles/index.bpr | 0 example_userfiles/pages/page1.bpr | 0 example_userfiles/pages/page2.bpr | 0 modules/config.py | 1 + modules/context_mngr.py | 1 + modules/error_mngr.py | 1 + modules/export.py | 1 + modules/parser.py | 1 + modules/preparser.py | 1 + modules/sitecrawler.py | 1 + modules/sitecreator.py | 1 + workflow-documents/{draft.vky => draft.bpr} | 0 18 files changed, 11 insertions(+) create mode 100644 .github/workflows/configs/parser_config.yml create mode 100644 bparse.py create mode 100644 example_userfiles/config/aliases.yml create mode 100644 example_userfiles/config/glossary.yml create mode 100644 example_userfiles/config/website.yml create mode 100644 example_userfiles/index.bpr create mode 100644 example_userfiles/pages/page1.bpr create mode 100644 example_userfiles/pages/page2.bpr create mode 100644 modules/config.py create mode 100644 modules/context_mngr.py create mode 100644 modules/error_mngr.py create mode 100644 modules/export.py create mode 100644 modules/parser.py create mode 100644 modules/preparser.py create mode 100644 modules/sitecrawler.py create mode 100644 modules/sitecreator.py rename workflow-documents/{draft.vky => draft.bpr} (100%) diff --git a/.github/workflows/configs/parser_config.yml b/.github/workflows/configs/parser_config.yml new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 57b30bc..1ca8af6 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,6 @@ Bootstraparse is a personal project started with a specific goal in mind: creating static html pages for direct display from a markdown-like file. Bootstraparse aims to be customisable in that regard, but its first iteration and main focus will be to create a bootstrap-powered html. +Refer to the `example_userfiles` for an idea of what the parser expects you to feed it and `example_website` for the generated result. + [![Python application](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml/badge.svg)](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml) diff --git a/bparse.py b/bparse.py new file mode 100644 index 0000000..2071ee4 --- /dev/null +++ b/bparse.py @@ -0,0 +1 @@ +# Main program, use this to start parsing \ No newline at end of file diff --git a/example_userfiles/config/aliases.yml b/example_userfiles/config/aliases.yml new file mode 100644 index 0000000..e69de29 diff --git a/example_userfiles/config/glossary.yml b/example_userfiles/config/glossary.yml new file mode 100644 index 0000000..e69de29 diff --git a/example_userfiles/config/website.yml b/example_userfiles/config/website.yml new file mode 100644 index 0000000..e69de29 diff --git a/example_userfiles/index.bpr b/example_userfiles/index.bpr new file mode 100644 index 0000000..e69de29 diff --git a/example_userfiles/pages/page1.bpr b/example_userfiles/pages/page1.bpr new file mode 100644 index 0000000..e69de29 diff --git a/example_userfiles/pages/page2.bpr b/example_userfiles/pages/page2.bpr new file mode 100644 index 0000000..e69de29 diff --git a/modules/config.py b/modules/config.py new file mode 100644 index 0000000..d123fe7 --- /dev/null +++ b/modules/config.py @@ -0,0 +1 @@ +# Interprets config files \ No newline at end of file diff --git a/modules/context_mngr.py b/modules/context_mngr.py new file mode 100644 index 0000000..cbe66d2 --- /dev/null +++ b/modules/context_mngr.py @@ -0,0 +1 @@ +# Interprets where the parser is located and resolves errors \ No newline at end of file diff --git a/modules/error_mngr.py b/modules/error_mngr.py new file mode 100644 index 0000000..b10c7af --- /dev/null +++ b/modules/error_mngr.py @@ -0,0 +1 @@ +# Dedicated module for defining and interpreting errors as well as generating error messages \ No newline at end of file diff --git a/modules/export.py b/modules/export.py new file mode 100644 index 0000000..d9f7a15 --- /dev/null +++ b/modules/export.py @@ -0,0 +1 @@ +# Module for final generation of the translated website \ No newline at end of file diff --git a/modules/parser.py b/modules/parser.py new file mode 100644 index 0000000..8ce05e8 --- /dev/null +++ b/modules/parser.py @@ -0,0 +1 @@ +# Main parser, interprets userfiles and translates into html \ No newline at end of file diff --git a/modules/preparser.py b/modules/preparser.py new file mode 100644 index 0000000..409a5ed --- /dev/null +++ b/modules/preparser.py @@ -0,0 +1 @@ +# Module for pre-parsing userfiles in preparation for the parser \ No newline at end of file diff --git a/modules/sitecrawler.py b/modules/sitecrawler.py new file mode 100644 index 0000000..dee44ac --- /dev/null +++ b/modules/sitecrawler.py @@ -0,0 +1 @@ +# Module for file and directories repartition \ No newline at end of file diff --git a/modules/sitecreator.py b/modules/sitecreator.py new file mode 100644 index 0000000..e395ea6 --- /dev/null +++ b/modules/sitecreator.py @@ -0,0 +1 @@ +# Module sequencing the successive actions necessary for website building \ No newline at end of file diff --git a/workflow-documents/draft.vky b/workflow-documents/draft.bpr similarity index 100% rename from workflow-documents/draft.vky rename to workflow-documents/draft.bpr