Fix: PR Feedback and schema change from FCC

- Update action to 'main' branch - Resolves: #5 (comment)
- Fix schema change issue with FCC. Challenge order is now a list
of dictionaries
- Linter fix
- Fix publisher and creator attributes - Resolves: #5 (comment)
and #5 (comment) and
#5 (comment)
- is_front on redirects only. Resolves: #5 (comment)
-

.github/workflows/qa.yaml

@@ -2,7 +2,7 @@ name: QA
 
 on:
   push:
-    branches: master
+    branches: main
   pull_request:
 
 env:

Makefile

@@ -49,7 +49,7 @@ prebuild:
 
 zim:
 	python3 openzim/fcc2zim zim --clientdir ${CLIENTDIR} --outzim ${OUTPATH} \
-	--language ${LANG} --name ${NAME} --title ${TITLE} --description ${DESCRIPTION} --creator Makefile
+	--language ${LANG} --name ${NAME} --title ${TITLE} --description ${DESCRIPTION}
 
 all: clean fetch prebuild zim
 
@@ -64,7 +64,7 @@ docker_build:
 docker_run:
 	docker run --rm -it -v $(PWD)/tmp:/tmp/fcc2zim openzim/fcc2zim all --clientdir ${CLIENTDIR} --outdir=./client/dist/fcc --outzim ${OUTPATH} \
 	--language ${LANG} --tmpdir=/tmp/fcc2zim --course=${COURSE_CSV} \
-	--name ${NAME} --title ${TITLE} --description ${DESCRIPTION} --creator Docker
+	--name ${NAME} --title ${TITLE} --description ${DESCRIPTION}
 
 docker_debug:
 	docker run --rm -it --entrypoint=/bin/bash openzim/fcc2zim

openzim/fcc2zim

@@ -48,7 +48,8 @@ if __name__ == "__main__":
     zim_cmd.add_argument('--title', type=str, help='Title of zim file', required=True)
     zim_cmd.add_argument('--name', type=str, help='Name of zim file', required=True)
     zim_cmd.add_argument('--description', type=str, help='Description of zim file', required=True)
-    zim_cmd.add_argument('--creator', type=str, help='Creator of the zim file', required=True)
+    zim_cmd.add_argument('--creator', type=str, help='Creator of the zim files content', required=False)
+    zim_cmd.add_argument('--publisher', type=str, help='Publisher of the zim file', required=False)
 
     all_cmd = sub_parsers.add_parser('all', help='fetch, build and package up a zim file')
     all_cmd.add_argument('--force', type=bool, help='force a re-download of the curriculum zip')
@@ -62,7 +63,8 @@ if __name__ == "__main__":
     all_cmd.add_argument('--title', type=str, help='Title of zim file', required=True)
     all_cmd.add_argument('--name', type=str, help='Name of zim file', required=True)
     all_cmd.add_argument('--description', type=str, help='Description of zim file', required=True)
-    all_cmd.add_argument('--creator', type=str, help='Creator of the zim file', required=True)
+    all_cmd.add_argument('--creator', type=str, help='Creator of the zim files content', required=False)
+    all_cmd.add_argument('--publisher', type=str, help='Publisher of the zim file', required=False)
 
     args = parser.parse_args()
     if args.command:

openzim/fcctozim/build.py

@@ -41,7 +41,8 @@ def build(arguments):
     name = arguments.name
     title = arguments.title
     description = arguments.description
-    creator = arguments.creator
+    creator = arguments.creator or "freeCodeCamp"
+    publisher = arguments.publisher or "openZIM"
 
     logger.info(
         f"Building {clientdir} for {language} => {outpath} - Version: {VERSION}"
@@ -66,7 +67,7 @@ def build(arguments):
     with Creator(outpath, main_path.as_posix()).config_metadata(
         Name=name,
         Title=title,
-        Publisher="Kiwix",
+        Publisher=publisher,
         Date=datetime.now(),
         Creator=creator,
         Description=description,
@@ -94,5 +95,6 @@ def build(arguments):
                 content=bytes(content, "utf-8"),
                 title=redir_title,
                 mimetype="text/html",
+                is_front=True,
             )
             # Example index.html#/english/regular-expressions/extract-matches

openzim/fcctozim/challenge.py

@@ -12,7 +12,6 @@
 def read_yaml_frontmatter(filename: pathlib.Path):
     with open(filename) as f:
         return next(yaml.load_all(f, Loader=yaml.FullLoader))
-        return front_matter
 
 
 class Challenge:

openzim/fcctozim/prebuild.py

@@ -102,12 +102,13 @@ def prebuild_command(arguments):
 
     # eg. ['basic-javascript', 'debugging']
     for course in course_list_str.split(","):
+        print(f"Prebuilding {course}")
         meta = json.loads(
             curriculum_dir.joinpath("_meta", course, "meta.json").read_text()
         )
 
         # Get the order that the challenges should be completed in for <course>
-        ids = [item[0] for item in meta["challengeOrder"]]
+        ids = [item["id"] for item in meta["challengeOrder"]]
         superblock = meta["superBlock"]
 
         challenge_list: List[Challenge] = []