with class 'LTBranding'")
+ img_src = img_tag["src"]
+ if not img_src:
+ raise LibreTextsParsingError(
+ "![]()
in
with class 'LTBranding' has no src attribute"
+ )
+ if isinstance(img_src, list):
+ raise LibreTextsParsingError(
+ "![]()
in
with class 'LTBranding' has too many src attribute"
+ )
+ return img_src
+
+
+def _get_welcome_text_from_home(soup: BeautifulSoup) -> list[str]:
+ content_section = soup.find("section", class_="mt-content-container")
+ if not content_section or isinstance(content_section, NavigableString):
+ raise LibreTextsParsingError(
+ " with class 'mt-content-container' not found"
+ )
+ welcome_text: list[str] = []
+ for paragraph in content_section.find_all("p"):
+ if paragraph.find("div", class_="mt-category-container"):
+ # once we found a mt-category-container div, we are not in the welcome text
+ # anymore
+ break
+ if paragraph_text := paragraph.text:
+ welcome_text.append(paragraph_text)
+ return welcome_text
diff --git a/scraper/src/libretexts2zim/constants.py b/scraper/src/libretexts2zim/constants.py
new file mode 100644
index 0000000..8525f34
--- /dev/null
+++ b/scraper/src/libretexts2zim/constants.py
@@ -0,0 +1,17 @@
+import logging
+import pathlib
+
+from zimscraperlib.logging import (
+ getLogger,
+)
+
+from libretexts2zim.__about__ import __version__
+
+NAME = "libretexts2zim"
+VERSION = __version__
+ROOT_DIR = pathlib.Path(__file__).parent
+
+# As of 2024-09-24, all courses appears to be in English.
+LANGUAGE_ISO_639_3 = "eng"
+
+logger = getLogger(NAME, level=logging.DEBUG)
diff --git a/scraper/src/libretexts2zim/entrypoint.py b/scraper/src/libretexts2zim/entrypoint.py
new file mode 100644
index 0000000..0cdd6dd
--- /dev/null
+++ b/scraper/src/libretexts2zim/entrypoint.py
@@ -0,0 +1,105 @@
+import argparse
+import logging
+import os
+
+from libretexts2zim.client import LibreTextsClient
+from libretexts2zim.constants import (
+ NAME,
+ VERSION,
+ logger,
+)
+from libretexts2zim.generator import ContentFilter, Generator
+from libretexts2zim.zimconfig import ZimConfig
+
+
+def zim_defaults() -> ZimConfig:
+ """Returns the default configuration for ZIM generation."""
+ return ZimConfig(
+ secondary_color="#FFFFFF",
+ library_name="not_used", # this is always replaced because arg is required
+ file_name_format="libretexts_en_{clean_slug}_{period}",
+ name_format="libretexts_en_{clean_slug}",
+ creator="LibreTexts",
+ publisher="openZIM",
+ title_format="{name} courses",
+ description_format="{name} courses by LibreTexts",
+ long_description_format=None,
+ tags="libretexts;{clean_slug}",
+ )
+
+
+def main() -> None:
+ parser = argparse.ArgumentParser(
+ prog=NAME,
+ )
+
+ parser.add_argument(
+ "--debug", help="Enable verbose output", action="store_true", default=False
+ )
+
+ parser.add_argument(
+ "--version",
+ help="Display scraper version and exit",
+ action="version",
+ version=VERSION,
+ )
+
+ parser.add_argument(
+ "--output",
+ help="Output folder for ZIMs. Default: /output",
+ default="/output",
+ dest="output_folder",
+ )
+
+ parser.add_argument(
+ "--zimui-dist",
+ type=str,
+ help=(
+ "Directory containing Vite build output from the Zim UI Vue.JS application"
+ ),
+ default=os.getenv("LIBRETEXTS_ZIMUI_DIST", "../zimui/dist"),
+ )
+
+ # ZIM configuration flags
+ ZimConfig.add_flags(
+ parser,
+ zim_defaults(),
+ )
+
+ # Document selection flags
+ ContentFilter.add_flags(parser)
+
+ # Client configuration flags
+ parser.add_argument(
+ "--library-slug",
+ help="URL prefix for the course, e.g. for Geosciences which is at "
+ "https://geo.libretexts.org/, the slug is `geo`",
+ required=True,
+ )
+
+ args = parser.parse_args()
+
+ logger.setLevel(level=logging.DEBUG if args.debug else logging.INFO)
+
+ try:
+ zim_config = ZimConfig.of(args)
+ doc_filter = ContentFilter.of(args)
+ libretexts_client = LibreTextsClient(
+ library_slug=args.library_slug,
+ )
+
+ Generator(
+ libretexts_client=libretexts_client,
+ zim_config=zim_config,
+ output_folder=args.output_folder,
+ zimui_dist=args.zimui_dist,
+ content_filter=doc_filter,
+ ).run()
+ except Exception as e:
+ logger.exception(e)
+ logger.error(f"Generation failed with the following error: {e}")
+ raise SystemExit(1) from e
+
+
+if __name__ == "__main__":
+ main()
diff --git a/scraper/src/libretexts2zim/generator.py b/scraper/src/libretexts2zim/generator.py
new file mode 100644
index 0000000..f857713
--- /dev/null
+++ b/scraper/src/libretexts2zim/generator.py
@@ -0,0 +1,257 @@
+import argparse
+import datetime
+import os
+import re
+from io import BytesIO
+from pathlib import Path
+
+from pydantic import BaseModel
+from zimscraperlib.download import (
+ stream_file, # pyright: ignore[reportUnknownVariableType]
+)
+from zimscraperlib.image import resize_image
+from zimscraperlib.zim import Creator
+from zimscraperlib.zim.indexing import IndexData
+
+from libretexts2zim.client import LibreTextsClient, LibreTextsMetadata
+from libretexts2zim.constants import LANGUAGE_ISO_639_3, NAME, ROOT_DIR, VERSION, logger
+from libretexts2zim.ui import ConfigModel, HomeModel, SharedModel
+from libretexts2zim.zimconfig import ZimConfig
+
+
+class InvalidFormatError(Exception):
+ """Raised when a user supplied template has an invalid parameter."""
+
+ pass
+
+
+class MissingDocumentError(Exception):
+ """Raised when the user specified a slug that doesn't exist."""
+
+ pass
+
+
+class ContentFilter(BaseModel):
+ """Supports filtering documents by user provided attributes."""
+
+ # If specified, only shelves matching the regex are included.
+ shelves_include: str | None
+ # If specified, shelves matching the regex are excluded.
+ shelves_exclude: str | None
+
+ @staticmethod
+ def add_flags(parser: argparse.ArgumentParser):
+ """Adds flags to the given parser with the given defaults."""
+
+ parser.add_argument(
+ "--shelves-include",
+ help="Includes only shelves matching the given regular expression.",
+ metavar="REGEX",
+ )
+
+ parser.add_argument(
+ "--shelves-exclude",
+ help="Excludes shelves matching the given regular expression.",
+ metavar="REGEX",
+ )
+
+ @staticmethod
+ def of(namespace: argparse.Namespace) -> "ContentFilter":
+ """Parses a namespace to create a new DocFilter."""
+ return ContentFilter.model_validate(namespace, from_attributes=True)
+
+ # TODO: implement filtering of shelves based on configured regex
+ # def filter(self, shelves: list[LibretextsShelve]) -> list[LibretextsShelve]:
+ # """Filters docs based on the user's choices."""
+ # selected: list[LibretextsShelve] = []
+ # for shelve in shelves:
+ # ....
+ # return selected
+
+
+def add_item_for(
+ creator: Creator,
+ path: str,
+ title: str | None = None,
+ *,
+ fpath: Path | None = None,
+ content: bytes | str | None = None,
+ mimetype: str | None = None,
+ is_front: bool | None = None,
+ should_compress: bool | None = None,
+ delete_fpath: bool | None = False,
+ duplicate_ok: bool | None = None,
+ index_data: IndexData | None = None,
+ auto_index: bool = True,
+):
+ creator.add_item_for( # pyright: ignore[reportUnknownMemberType]
+ path=path,
+ title=title,
+ fpath=fpath,
+ content=content,
+ mimetype=mimetype,
+ is_front=is_front,
+ should_compress=should_compress,
+ delete_fpath=delete_fpath,
+ duplicate_ok=duplicate_ok,
+ index_data=index_data,
+ auto_index=auto_index,
+ )
+
+
+class Generator:
+ """Generates ZIMs based on the user's configuration."""
+
+ def __init__(
+ self,
+ libretexts_client: LibreTextsClient,
+ zim_config: ZimConfig,
+ content_filter: ContentFilter,
+ output_folder: str,
+ zimui_dist: str,
+ ) -> None:
+ """Initializes Generator.
+
+ Parameters:
+ libretexts_client: Client that connects with Libretexts website
+ zim_config: Configuration for ZIM metadata.
+ content_filter: User supplied filter selecting with content to convert.
+ output_folder: Directory to write ZIMs into.
+ """
+ self.libretexts_client = libretexts_client
+ self.zim_config = zim_config
+ self.doc_filter = content_filter
+ self.output_folder = output_folder
+ self.zimui_dist = Path(zimui_dist)
+
+ os.makedirs(self.output_folder, exist_ok=True)
+
+ self.zim_illustration_path = self.libretexts_newsite_path(
+ "header_logo_mini.png"
+ )
+
+ @staticmethod
+ def libretexts_newsite_path(name: str) -> Path:
+ """Returns the path to name in the third_party/libretexts_newsite folder.
+
+ Raises ValueError if the resource doesn't exist.
+ """
+ path = ROOT_DIR.joinpath("third_party", "libretexts_newsite", name)
+ if not path.exists():
+ raise ValueError(f"File not found at {path}")
+ return path
+
+ def run(self) -> Path:
+ """Generates a zim for a single document.
+
+ Returns the path to the gernated ZIM.
+ """
+ logger.info("Generating ZIM")
+
+ metadata = LibreTextsMetadata(
+ name=self.zim_config.library_name, slug=self.libretexts_client.library_slug
+ )
+ formatted_config = self.zim_config.format(metadata.placeholders())
+ zim_path = Path(self.output_folder, f"{formatted_config.file_name_format}.zim")
+
+ if zim_path.exists():
+ logger.error(f" {zim_path} already exists, aborting.")
+ raise SystemExit(f"ZIM file already exists at {zim_path}")
+
+ logger.info(f" Writing to: {zim_path}")
+
+ creator = Creator(zim_path, "index.html")
+
+ logger.debug("Resizing ZIM illustration")
+ zim_illustration = BytesIO()
+ resize_image(
+ src=self.zim_illustration_path,
+ dst=zim_illustration,
+ width=48,
+ height=48,
+ method="cover",
+ )
+
+ logger.debug("Configuring metadata")
+ creator.config_metadata(
+ Name=formatted_config.name_format,
+ Title=formatted_config.title_format,
+ Publisher=formatted_config.publisher,
+ Date=datetime.datetime.now(tz=datetime.UTC).date(),
+ Creator=formatted_config.creator,
+ Description=formatted_config.description_format,
+ LongDescription=formatted_config.long_description_format,
+ # As of 2024-09-4 all documentation is in English.
+ Language=LANGUAGE_ISO_639_3,
+ Tags=formatted_config.tags,
+ Scraper=f"{NAME} v{VERSION}",
+ Illustration_48x48_at_1=zim_illustration.getvalue(),
+ )
+ del zim_illustration
+
+ # Start creator early to detect problems early.
+ with creator as creator:
+
+ logger.info(" Storing configuration...")
+ add_item_for(
+ creator,
+ "content/config.json",
+ content=ConfigModel(
+ secondary_color=self.zim_config.secondary_color
+ ).model_dump_json(by_alias=True),
+ )
+
+ logger.info(" Storing the ZIM UI")
+
+ logger.info(" Fetching and storing home page...")
+ home = self.libretexts_client.get_home()
+ welcome_image = BytesIO()
+ stream_file(home.welcome_image_url, byte_stream=welcome_image)
+ add_item_for(creator, "content/logo.png", content=welcome_image.getvalue())
+ del welcome_image
+ add_item_for(
+ creator,
+ "content/shared.json",
+ content=SharedModel(logo_path="content/logo.png").model_dump_json(
+ by_alias=True
+ ),
+ )
+ add_item_for(
+ creator,
+ "content/home.json",
+ content=HomeModel(
+ welcome_text_paragraphs=home.welcome_text_paragraphs
+ ).model_dump_json(by_alias=True),
+ )
+
+ logger.info(f"Adding files in {self.zimui_dist}")
+ for file in self.zimui_dist.rglob("*"):
+ if file.is_dir():
+ continue
+ path = str(Path(file).relative_to(self.zimui_dist))
+ logger.debug(f"Adding {path} to ZIM")
+ if path == "index.html": # Change index.html title and add to ZIM
+ index_html_path = self.zimui_dist / path
+ html_content = index_html_path.read_text(encoding="utf-8")
+ new_html_content = re.sub(
+ r"()(.*?)( )",
+ rf"\1{formatted_config.title_format}\3",
+ html_content,
+ flags=re.IGNORECASE,
+ )
+ add_item_for(
+ creator=creator,
+ path=path,
+ content=new_html_content,
+ mimetype="text/html",
+ is_front=True,
+ )
+ else:
+ add_item_for(
+ creator=creator,
+ path=path,
+ fpath=file,
+ is_front=False,
+ )
+
+ return zim_path
diff --git a/scraper/src/libretexts2zim/third_party/README.md b/scraper/src/libretexts2zim/third_party/README.md
new file mode 100644
index 0000000..6974785
--- /dev/null
+++ b/scraper/src/libretexts2zim/third_party/README.md
@@ -0,0 +1 @@
+This folder contains resources fetched from third parties, with accompaying license information.
diff --git a/scraper/src/libretexts2zim/third_party/libretexts_newsite/LICENSE b/scraper/src/libretexts2zim/third_party/libretexts_newsite/LICENSE
new file mode 100644
index 0000000..7416b6f
--- /dev/null
+++ b/scraper/src/libretexts2zim/third_party/libretexts_newsite/LICENSE
@@ -0,0 +1,386 @@
+Attribution 4.0 International
+
+=======================================================================
+
+Creative Commons Corporation ("Creative Commons") is not a law firm and
+does not provide legal services or legal advice. Distribution of
+Creative Commons public licenses does not create a lawyer-client or
+other relationship. Creative Commons makes its licenses and related
+information available on an "as-is" basis. Creative Commons gives no
+warranties regarding its licenses, any material licensed under their
+terms and conditions, or any related information. Creative Commons
+disclaims all liability for damages resulting from their use to the
+fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and
+conditions that creators and other rights holders may use to share
+original works of authorship and other material subject to copyright
+and certain other rights specified in the public license below. The
+following considerations are for informational purposes only, are not
+exhaustive, and do not form part of our licenses.
+
+ Considerations for licensors: Our public licenses are
+ intended for use by those authorized to give the public
+ permission to use material in ways otherwise restricted by
+ copyright and certain other rights. Our licenses are
+ irrevocable. Licensors should read and understand the terms
+ and conditions of the license they choose before applying it.
+ Licensors should also secure all rights necessary before
+ applying our licenses so that the public can reuse the
+ material as expected. Licensors should clearly mark any
+ material not subject to the license. This includes other CC-
+ licensed material, or material used under an exception or
+ limitation to copyright. More considerations for licensors:
+ wiki.creativecommons.org/Considerations_for_licensors
+
+ Considerations for the public: By using one of our public
+ licenses, a licensor grants the public permission to use the
+ licensed material under specified terms and conditions. If
+ the licensor's permission is not necessary for any reason--for
+ example, because of any applicable exception or limitation to
+ copyright--then that use is not regulated by the license. Our
+ licenses grant only permissions under copyright and certain
+ other rights that a licensor has authority to grant. Use of
+ the licensed material may still be restricted for other
+ reasons, including because others have copyright or other
+ rights in the material. A licensor may make special requests,
+ such as asking that all changes be marked or described.
+ Although not required by our licenses, you are encouraged to
+ respect those requests where reasonable. More considerations
+ for the public:
+ wiki.creativecommons.org/Considerations_for_licensees
+
+=======================================================================
+
+Creative Commons Attribution 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution 4.0 International Public License ("Public License"). To the
+extent this Public License may be interpreted as a contract, You are
+granted the Licensed Rights in consideration of Your acceptance of
+these terms and conditions, and the Licensor grants You such rights in
+consideration of benefits the Licensor receives from making the
+Licensed Material available under these terms and conditions.
+
+Section 1 -- Definitions.
+
+a. Adapted Material means material subject to Copyright and Similar
+Rights that is derived from or based upon the Licensed Material
+and in which the Licensed Material is translated, altered,
+arranged, transformed, or otherwise modified in a manner requiring
+permission under the Copyright and Similar Rights held by the
+Licensor. For purposes of this Public License, where the Licensed
+Material is a musical work, performance, or sound recording,
+Adapted Material is always produced where the Licensed Material is
+synched in timed relation with a moving image.
+
+b. Adapter's License means the license You apply to Your Copyright
+and Similar Rights in Your contributions to Adapted Material in
+accordance with the terms and conditions of this Public License.
+
+c. Copyright and Similar Rights means copyright and/or similar rights
+closely related to copyright including, without limitation,
+performance, broadcast, sound recording, and Sui Generis Database
+Rights, without regard to how the rights are labeled or
+categorized. For purposes of this Public License, the rights
+specified in Section 2(b)(1)-(2) are not Copyright and Similar
+Rights.
+
+d. Effective Technological Measures means those measures that, in the
+absence of proper authority, may not be circumvented under laws
+fulfilling obligations under Article 11 of the WIPO Copyright
+Treaty adopted on December 20, 1996, and/or similar international
+agreements.
+
+e. Exceptions and Limitations means fair use, fair dealing, and/or
+any other exception or limitation to Copyright and Similar Rights
+that applies to Your use of the Licensed Material.
+
+f. Licensed Material means the artistic or literary work, database,
+or other material to which the Licensor applied this Public
+License.
+
+g. Licensed Rights means the rights granted to You subject to the
+terms and conditions of this Public License, which are limited to
+all Copyright and Similar Rights that apply to Your use of the
+Licensed Material and that the Licensor has authority to license.
+
+h. Licensor means the individual(s) or entity(ies) granting rights
+under this Public License.
+
+i. Share means to provide material to the public by any means or
+process that requires permission under the Licensed Rights, such
+as reproduction, public display, public performance, distribution,
+dissemination, communication, or importation, and to make material
+available to the public including in ways that members of the
+public may access the material from a place and at a time
+individually chosen by them.
+
+j. Sui Generis Database Rights means rights other than copyright
+resulting from Directive 96/9/EC of the European Parliament and of
+the Council of 11 March 1996 on the legal protection of databases,
+as amended and/or succeeded, as well as other essentially
+equivalent rights anywhere in the world.
+
+k. You means the individual or entity exercising the Licensed Rights
+under this Public License. Your has a corresponding meaning.
+
+Section 2 -- Scope.
+
+a. License grant.
+
+ 1. Subject to the terms and conditions of this Public License,
+ the Licensor hereby grants You a worldwide, royalty-free,
+ non-sublicensable, non-exclusive, irrevocable license to
+ exercise the Licensed Rights in the Licensed Material to:
+
+ a. reproduce and Share the Licensed Material, in whole or
+ in part; and
+
+ b. produce, reproduce, and Share Adapted Material.
+
+ 2. Exceptions and Limitations. For the avoidance of doubt, where
+ Exceptions and Limitations apply to Your use, this Public
+ License does not apply, and You do not need to comply with
+ its terms and conditions.
+
+ 3. Term. The term of this Public License is specified in Section
+ 6(a).
+
+ 4. Media and formats; technical modifications allowed. The
+ Licensor authorizes You to exercise the Licensed Rights in
+ all media and formats whether now known or hereafter created,
+ and to make technical modifications necessary to do so. The
+ Licensor waives and/or agrees not to assert any right or
+ authority to forbid You from making technical modifications
+ necessary to exercise the Licensed Rights, including
+ technical modifications necessary to circumvent Effective
+ Technological Measures. For purposes of this Public License,
+ simply making modifications authorized by this Section 2(a)
+ (4) never produces Adapted Material.
+
+ 5. Downstream recipients.
+
+ a. Offer from the Licensor -- Licensed Material. Every
+ recipient of the Licensed Material automatically
+ receives an offer from the Licensor to exercise the
+ Licensed Rights under the terms and conditions of this
+ Public License.
+
+ b. No downstream restrictions. You may not offer or impose
+ any additional or different terms or conditions on, or
+ apply any Effective Technological Measures to, the
+ Licensed Material if doing so restricts exercise of the
+ Licensed Rights by any recipient of the Licensed
+ Material.
+
+ 6. No endorsement. Nothing in this Public License constitutes or
+ may be construed as permission to assert or imply that You
+ are, or that Your use of the Licensed Material is, connected
+ with, or sponsored, endorsed, or granted official status by,
+ the Licensor or others designated to receive attribution as
+ provided in Section 3(a)(1)(A)(i).
+
+b. Other rights.
+
+ 1. Moral rights, such as the right of integrity, are not
+ licensed under this Public License, nor are publicity,
+ privacy, and/or other similar personality rights; however, to
+ the extent possible, the Licensor waives and/or agrees not to
+ assert any such rights held by the Licensor to the limited
+ extent necessary to allow You to exercise the Licensed
+ Rights, but not otherwise.
+
+ 2. Patent and trademark rights are not licensed under this
+ Public License.
+
+ 3. To the extent possible, the Licensor waives any right to
+ collect royalties from You for the exercise of the Licensed
+ Rights, whether directly or through a collecting society
+ under any voluntary or waivable statutory or compulsory
+ licensing scheme. In all other cases the Licensor expressly
+ reserves any right to collect such royalties.
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+a. Attribution.
+
+ 1. If You Share the Licensed Material (including in modified
+ form), You must:
+
+ a. retain the following if it is supplied by the Licensor
+ with the Licensed Material:
+
+ i. identification of the creator(s) of the Licensed
+ Material and any others designated to receive
+ attribution, in any reasonable manner requested by
+ the Licensor (including by pseudonym if
+ designated);
+
+ ii. a copyright notice;
+
+ iii. a notice that refers to this Public License;
+
+ iv. a notice that refers to the disclaimer of
+ warranties;
+
+ v. a URI or hyperlink to the Licensed Material to the
+ extent reasonably practicable;
+
+ b. indicate if You modified the Licensed Material and
+ retain an indication of any previous modifications; and
+
+ c. indicate the Licensed Material is licensed under this
+ Public License, and include the text of, or the URI or
+ hyperlink to, this Public License.
+
+ 2. You may satisfy the conditions in Section 3(a)(1) in any
+ reasonable manner based on the medium, means, and context in
+ which You Share the Licensed Material. For example, it may be
+ reasonable to satisfy the conditions by providing a URI or
+ hyperlink to a resource that includes the required
+ information.
+
+ 3. If requested by the Licensor, You must remove any of the
+ information required by Section 3(a)(1)(A) to the extent
+ reasonably practicable.
+
+ 4. If You Share Adapted Material You produce, the Adapter's
+ License You apply must not prevent recipients of the Adapted
+ Material from complying with this Public License.
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+to extract, reuse, reproduce, and Share all or a substantial
+portion of the contents of the database;
+
+b. if You include all or a substantial portion of the database
+contents in a database in which You have Sui Generis Database
+Rights, then the database in which You have Sui Generis Database
+Rights (but not its individual contents) is Adapted Material; and
+
+c. You must comply with the conditions in Section 3(a) if You Share
+all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+c. The disclaimer of warranties and limitation of liability provided
+above shall be interpreted in a manner that, to the extent
+possible, most closely approximates an absolute disclaimer and
+waiver of all liability.
+
+Section 6 -- Term and Termination.
+
+a. This Public License applies for the term of the Copyright and
+Similar Rights licensed here. However, if You fail to comply with
+this Public License, then Your rights under this Public License
+terminate automatically.
+
+b. Where Your right to use the Licensed Material has terminated under
+Section 6(a), it reinstates:
+
+ 1. automatically as of the date the violation is cured, provided
+ it is cured within 30 days of Your discovery of the
+ violation; or
+
+ 2. upon express reinstatement by the Licensor.
+
+ For the avoidance of doubt, this Section 6(b) does not affect any
+ right the Licensor may have to seek remedies for Your violations
+ of this Public License.
+
+c. For the avoidance of doubt, the Licensor may also offer the
+Licensed Material under separate terms or conditions or stop
+distributing the Licensed Material at any time; however, doing so
+will not terminate this Public License.
+
+d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+License.
+
+Section 7 -- Other Terms and Conditions.
+
+a. The Licensor shall not be bound by any additional or different
+terms or conditions communicated by You unless expressly agreed.
+
+b. Any arrangements, understandings, or agreements regarding the
+Licensed Material not stated herein are separate from and
+independent of the terms and conditions of this Public License.
+
+Section 8 -- Interpretation.
+
+a. For the avoidance of doubt, this Public License does not, and
+shall not be interpreted to, reduce, limit, restrict, or impose
+conditions on any use of the Licensed Material that could lawfully
+be made without permission under this Public License.
+
+b. To the extent possible, if any provision of this Public License is
+deemed unenforceable, it shall be automatically reformed to the
+minimum extent necessary to make it enforceable. If the provision
+cannot be reformed, it shall be severed from this Public License
+without affecting the enforceability of the remaining terms and
+conditions.
+
+c. No term or condition of this Public License will be waived and no
+failure to comply consented to unless expressly agreed to by the
+Licensor.
+
+d. Nothing in this Public License constitutes or may be interpreted
+as a limitation upon, or waiver of, any privileges and immunities
+that apply to the Licensor or You, including from the legal
+processes of any jurisdiction or authority.
+
+=======================================================================
+
+Creative Commons is not a party to its public licenses.
+Notwithstanding, Creative Commons may elect to apply one of its public
+licenses to material it publishes and in those instances will be
+considered the “Licensor.” The text of the Creative Commons public
+licenses is dedicated to the public domain under the CC0 Public Domain
+Dedication. Except for the limited purpose of indicating that material
+is shared under a Creative Commons public license or as otherwise
+permitted by the Creative Commons policies published at
+creativecommons.org/policies, Creative Commons does not authorize the
+use of the trademark "Creative Commons" or any other trademark or logo
+of Creative Commons without its prior written consent including,
+without limitation, in connection with any unauthorized modifications
+to any of its public licenses or any other arrangements,
+understandings, or agreements concerning use of licensed material. For
+the avoidance of doubt, this paragraph does not form part of the public
+licenses.
+
+Creative Commons may be contacted at creativecommons.org.
diff --git a/scraper/src/libretexts2zim/third_party/libretexts_newsite/README.md b/scraper/src/libretexts2zim/third_party/libretexts_newsite/README.md
new file mode 100644
index 0000000..0351b82
--- /dev/null
+++ b/scraper/src/libretexts2zim/third_party/libretexts_newsite/README.md
@@ -0,0 +1,5 @@
+Resources from this `libretexts_newsite` subfolder have been fetched from https://github.com/LibreTexts/NewSite
+where they are listed as licensed under "Creative Commons Attribution 4.0 International", see [LICENSE](LICENSE) file.
+
+- full_logo.png has been retrieved from https://github.com/LibreTexts/NewSite/blob/master/img/LibreTexts/full_logo.png or more precisely https://github.com/LibreTexts/NewSite/blob/08ae96a370f570a59851be7e8ec3dfed78653933/img/LibreTexts/full_logo.png
+- header_logo_mini.png has been retrieved from https://github.com/LibreTexts/NewSite/blob/master/img/LibreTexts/header_logo_mini.png or more precisely https://github.com/LibreTexts/NewSite/blob/08ae96a370f570a59851be7e8ec3dfed78653933/img/LibreTexts/header_logo_mini.png
diff --git a/scraper/src/libretexts2zim/third_party/libretexts_newsite/full_logo.png b/scraper/src/libretexts2zim/third_party/libretexts_newsite/full_logo.png
new file mode 100644
index 0000000..f375532
Binary files /dev/null and b/scraper/src/libretexts2zim/third_party/libretexts_newsite/full_logo.png differ
diff --git a/scraper/src/libretexts2zim/third_party/libretexts_newsite/header_logo_mini.png b/scraper/src/libretexts2zim/third_party/libretexts_newsite/header_logo_mini.png
new file mode 100644
index 0000000..e985e38
Binary files /dev/null and b/scraper/src/libretexts2zim/third_party/libretexts_newsite/header_logo_mini.png differ
diff --git a/scraper/src/libretexts2zim/ui.py b/scraper/src/libretexts2zim/ui.py
new file mode 100644
index 0000000..cf7864a
--- /dev/null
+++ b/scraper/src/libretexts2zim/ui.py
@@ -0,0 +1,20 @@
+from humps import camelize
+from pydantic import BaseModel, ConfigDict
+
+
+class CamelModel(BaseModel):
+ """Model to transform Python snake_case into JSON camelCase."""
+
+ model_config = ConfigDict(alias_generator=camelize, populate_by_name=True)
+
+
+class HomeModel(CamelModel):
+ welcome_text_paragraphs: list[str]
+
+
+class SharedModel(CamelModel):
+ logo_path: str
+
+
+class ConfigModel(CamelModel):
+ secondary_color: str
diff --git a/scraper/src/libretexts2zim/zimconfig.py b/scraper/src/libretexts2zim/zimconfig.py
new file mode 100644
index 0000000..d28baa0
--- /dev/null
+++ b/scraper/src/libretexts2zim/zimconfig.py
@@ -0,0 +1,180 @@
+import argparse
+
+from pydantic import BaseModel
+from zimscraperlib.constants import ( # pyright: ignore[reportMissingTypeStubs]
+ MAXIMUM_DESCRIPTION_METADATA_LENGTH,
+ MAXIMUM_LONG_DESCRIPTION_METADATA_LENGTH,
+ RECOMMENDED_MAX_TITLE_LENGTH,
+)
+
+
+class InvalidFormatError(Exception):
+ """Raised when a user supplied template has an invalid parameter."""
+
+ pass
+
+
+class ZimConfig(BaseModel):
+ """Common configuration for building ZIM files."""
+
+ # Displayable name for library courses, e.g. Geosciences
+ library_name: str
+ # File name for the ZIM.
+ file_name_format: str
+ # Name for the ZIM.
+ name_format: str
+ # Human readable title for the ZIM.
+ title_format: str
+ # Publisher for the ZIM.
+ publisher: str
+ # Creator of the content in the ZIM.
+ creator: str
+ # Short description for the ZIM.
+ description_format: str
+ # Long description for the ZIM.
+ long_description_format: str | None
+ # Semicolon delimited list of tags to apply to the ZIM.
+ tags: str
+ # Secondary (background) color of ZIM UI
+ secondary_color: str
+
+ @staticmethod
+ def add_flags(parser: argparse.ArgumentParser, defaults: "ZimConfig"):
+ """Adds flags to the given parser with the given defaults."""
+
+ parser.add_argument(
+ "--library-name",
+ help="Display name for the library courses, e.g. Geosciences",
+ required=True,
+ )
+
+ parser.add_argument(
+ "--creator",
+ help=f"Name of content creator. Default: {defaults.creator!r}",
+ default=defaults.creator,
+ )
+
+ parser.add_argument(
+ "--publisher",
+ help=f"Custom publisher name. Default: {defaults.publisher!r}",
+ default=defaults.publisher,
+ )
+
+ parser.add_argument(
+ "--file-name-format",
+ help="Custom file name format for individual ZIMs. "
+ f"Default: {defaults.file_name_format!r}",
+ default=defaults.file_name_format,
+ metavar="FORMAT",
+ )
+
+ parser.add_argument(
+ "--name-format",
+ help="Custom name format for individual ZIMs. "
+ f"Default: {defaults.name_format!r}",
+ default=defaults.name_format,
+ metavar="FORMAT",
+ )
+
+ parser.add_argument(
+ "--title-format",
+ help=f"Custom title format for individual ZIMs. "
+ f"Value will be truncated to {RECOMMENDED_MAX_TITLE_LENGTH} chars. "
+ f"Default: {defaults.title_format!r}",
+ default=defaults.title_format,
+ metavar="FORMAT",
+ )
+
+ parser.add_argument(
+ "--description-format",
+ help="Custom description format for individual ZIMs. Value will be "
+ f"truncated to {MAXIMUM_DESCRIPTION_METADATA_LENGTH} chars. "
+ f"Default: {defaults.title_format!r}",
+ default=defaults.description_format,
+ metavar="FORMAT",
+ )
+
+ parser.add_argument(
+ "--long-description-format",
+ help="Custom long description format for your ZIM. Value will be "
+ f"truncated to {MAXIMUM_LONG_DESCRIPTION_METADATA_LENGTH} chars. "
+ f"Default: {defaults.long_description_format!r}",
+ default=defaults.long_description_format,
+ metavar="FORMAT",
+ )
+
+ # Due to https://github.com/python/cpython/issues/60603 defaulting an array in
+ # argparse doesn't work so we expose the underlying semicolon delimited string.
+ parser.add_argument(
+ "--tags",
+ help="A semicolon (;) delimited list of tags to add to the ZIM."
+ "Formatting is supported. "
+ f"Default: {defaults.tags!r}",
+ default=defaults.tags,
+ )
+
+ parser.add_argument(
+ "--secondary-color",
+ help="Secondary (background) color of ZIM UI. Default: "
+ f"{defaults.secondary_color!r}",
+ default=defaults.secondary_color,
+ )
+
+ @staticmethod
+ def of(namespace: argparse.Namespace) -> "ZimConfig":
+ """Parses a namespace to create a new ZimConfig."""
+ return ZimConfig.model_validate(namespace, from_attributes=True)
+
+ def format(self, placeholders: dict[str, str]) -> "ZimConfig":
+ """Creates a ZimConfig with placeholders replaced and results truncated.
+
+ Raises: InvalidFormatError if one of the placeholders is invalid.
+ """
+
+ def fmt(string: str) -> str:
+ try:
+ return string.format(**placeholders)
+ except KeyError as e:
+ valid_placeholders = ", ".join(sorted(placeholders.keys()))
+ raise InvalidFormatError(
+ f"Invalid placeholder {e!s} in {string!r}, "
+ f"valid placeholders are: {valid_placeholders}"
+ ) from e
+
+ def check_length(string: str, field_name: str, length: int) -> str:
+ if len(string) > length:
+ raise ValueError(
+ f"{field_name} '{string[:15]}…' ({len(string)} chars) "
+ f"is longer than the allowed {length} chars"
+ )
+
+ return string
+
+ return ZimConfig(
+ secondary_color=self.secondary_color,
+ library_name=self.library_name,
+ file_name_format=fmt(self.file_name_format),
+ name_format=fmt(self.name_format),
+ title_format=check_length(
+ fmt(self.title_format),
+ "formatted title",
+ RECOMMENDED_MAX_TITLE_LENGTH,
+ ),
+ publisher=self.publisher,
+ creator=self.creator,
+ description_format=check_length(
+ fmt(self.description_format),
+ "formatted description",
+ MAXIMUM_DESCRIPTION_METADATA_LENGTH,
+ ),
+ long_description_format=(
+ check_length(
+ fmt(self.long_description_format),
+ "formatted long description",
+ MAXIMUM_LONG_DESCRIPTION_METADATA_LENGTH,
+ )
+ if self.long_description_format
+ else None
+ ),
+ tags=fmt(self.tags),
+ )
diff --git a/scraper/tasks.py b/scraper/tasks.py
new file mode 100644
index 0000000..87cd552
--- /dev/null
+++ b/scraper/tasks.py
@@ -0,0 +1,110 @@
+# pyright: strict, reportUntypedFunctionDecorator=false
+import os
+
+from invoke.context import Context
+from invoke.tasks import task # pyright: ignore [reportUnknownVariableType]
+
+use_pty = not os.getenv("CI", "")
+
+
+@task(optional=["args"], help={"args": "pytest additional arguments"})
+def test(ctx: Context, args: str = ""):
+ """run tests (without coverage)"""
+ ctx.run(f"pytest {args}", pty=use_pty)
+
+
+@task(optional=["args"], help={"args": "pytest additional arguments"})
+def test_cov(ctx: Context, args: str = ""):
+ """run test vith coverage"""
+ ctx.run(f"coverage run -m pytest {args}", pty=use_pty)
+
+
+@task(optional=["html"], help={"html": "flag to export html report"})
+def report_cov(ctx: Context, *, html: bool = False):
+ """report coverage"""
+ ctx.run("coverage combine", warn=True, pty=use_pty)
+ ctx.run("coverage report --show-missing", pty=use_pty)
+ ctx.run("coverage xml", pty=use_pty)
+ if html:
+ ctx.run("coverage html", pty=use_pty)
+
+
+@task(
+ optional=["args", "html"],
+ help={
+ "args": "pytest additional arguments",
+ "html": "flag to export html report",
+ },
+)
+def coverage(ctx: Context, args: str = "", *, html: bool = False):
+ """run tests and report coverage"""
+ test_cov(ctx, args=args)
+ report_cov(ctx, html=html)
+
+
+@task(optional=["args"], help={"args": "black additional arguments"})
+def lint_black(ctx: Context, args: str = "."):
+ args = args or "." # needed for hatch script
+ ctx.run("black --version", pty=use_pty)
+ ctx.run(f"black --check --diff {args}", pty=use_pty)
+
+
+@task(optional=["args"], help={"args": "ruff additional arguments"})
+def lint_ruff(ctx: Context, args: str = "."):
+ args = args or "." # needed for hatch script
+ ctx.run("ruff --version", pty=use_pty)
+ ctx.run(f"ruff check {args}", pty=use_pty)
+
+
+@task(
+ optional=["args"],
+ help={
+ "args": "linting tools (black, ruff) additional arguments, typically a path",
+ },
+)
+def lintall(ctx: Context, args: str = "."):
+ """Check linting"""
+ args = args or "." # needed for hatch script
+ lint_black(ctx, args)
+ lint_ruff(ctx, args)
+
+
+@task(optional=["args"], help={"args": "check tools (pyright) additional arguments"})
+def check_pyright(ctx: Context, args: str = ""):
+ """check static types with pyright"""
+ ctx.run("pyright --version")
+ ctx.run(f"pyright {args}", pty=use_pty)
+
+
+@task(optional=["args"], help={"args": "check tools (pyright) additional arguments"})
+def checkall(ctx: Context, args: str = ""):
+ """check static types"""
+ check_pyright(ctx, args)
+
+
+@task(optional=["args"], help={"args": "black additional arguments"})
+def fix_black(ctx: Context, args: str = "."):
+ """fix black formatting"""
+ args = args or "." # needed for hatch script
+ ctx.run(f"black {args}", pty=use_pty)
+
+
+@task(optional=["args"], help={"args": "ruff additional arguments"})
+def fix_ruff(ctx: Context, args: str = "."):
+ """fix all ruff rules"""
+ args = args or "." # needed for hatch script
+ ctx.run(f"ruff check --fix {args}", pty=use_pty)
+
+
+@task(
+ optional=["args"],
+ help={
+ "args": "linting tools (black, ruff) additional arguments, typically a path",
+ },
+)
+def fixall(ctx: Context, args: str = "."):
+ """Fix everything automatically"""
+ args = args or "." # needed for hatch script
+ fix_black(ctx, args)
+ fix_ruff(ctx, args)
+ lintall(ctx, args)
diff --git a/scraper/tests-integration/conftest.py b/scraper/tests-integration/conftest.py
new file mode 100644
index 0000000..c2ea7e8
--- /dev/null
+++ b/scraper/tests-integration/conftest.py
@@ -0,0 +1,29 @@
+import pytest
+
+
+@pytest.fixture(scope="module")
+def libretexts_slug() -> str:
+ return "https://geo.libretexts.org"
+
+
+@pytest.fixture(scope="module")
+def libretexts_url(libretexts_slug: str) -> str:
+ return f"https://{libretexts_slug}.libretexts.org"
+
+
+@pytest.fixture(scope="module")
+def home_png_size() -> int:
+ return 13461
+
+
+@pytest.fixture(scope="module")
+def home_welcome_text_paragraphs() -> list[str]:
+ return [
+ "Welcome to the Geosciences Library. This Living Library is a principal hub of "
+ "the LibreTexts project, which is a multi-institutional collaborative venture "
+ "to develop the next generation of open-access texts to improve postsecondary "
+ "education at all levels of higher learning. The LibreTexts approach is highly "
+ "collaborative where an Open Access textbook environment is under constant "
+ "revision by students, faculty, and outside experts to supplant conventional "
+ "paper-based books."
+ ]
diff --git a/scraper/tests-integration/test_client.py b/scraper/tests-integration/test_client.py
new file mode 100644
index 0000000..2e4889c
--- /dev/null
+++ b/scraper/tests-integration/test_client.py
@@ -0,0 +1,40 @@
+import io
+
+import pytest
+from zimscraperlib.download import (
+ stream_file, # pyright: ignore[reportUnknownVariableType]
+)
+from zimscraperlib.image.probing import format_for
+
+from libretexts2zim.client import LibreTextsClient, LibreTextsHome
+
+
+@pytest.fixture(scope="module")
+def client(libretexts_slug: str) -> LibreTextsClient:
+ return LibreTextsClient(library_slug=libretexts_slug)
+
+
+@pytest.fixture(scope="module")
+def home(client: LibreTextsClient) -> LibreTextsHome:
+ return client.get_home()
+
+
+def test_get_home_image_url(home: LibreTextsHome):
+ """Ensures proper image url is retrieved"""
+ assert home.welcome_image_url == "https://cdn.libretexts.net/Logos/geo_full.png"
+
+
+def test_get_home_image_size(home: LibreTextsHome, home_png_size: int):
+ """Ensures image url is retrievable"""
+ dst = io.BytesIO()
+ stream_file(home.welcome_image_url, byte_stream=dst)
+ assert format_for(dst, from_suffix=False) == "PNG"
+ assert len(dst.getvalue()) == home_png_size
+
+
+def test_get_home_welcome_text_paragraphs(
+ home: LibreTextsHome, home_welcome_text_paragraphs: list[str]
+):
+ """Ensures proper data is retrieved from home of libretexts"""
+
+ assert home.welcome_text_paragraphs == home_welcome_text_paragraphs
diff --git a/scraper/tests-integration/test_zim_content.py b/scraper/tests-integration/test_zim_content.py
new file mode 100644
index 0000000..492495f
--- /dev/null
+++ b/scraper/tests-integration/test_zim_content.py
@@ -0,0 +1,87 @@
+import json
+import os
+from pathlib import Path
+
+import pytest
+from zimscraperlib.zim import Archive
+
+ZIM_FILE_PATH = Path(os.getenv("ZIM_FILE_PATH", "/output/libretexts_en_geo.zim"))
+
+
+@pytest.fixture(scope="module")
+def zim_file_path() -> Path:
+ return ZIM_FILE_PATH
+
+
+@pytest.fixture(scope="module")
+def zim_fh() -> Archive:
+ return Archive(ZIM_FILE_PATH)
+
+
+def test_is_file(zim_file_path: Path):
+ """Ensure ZIM file exists"""
+ assert os.path.isfile(zim_file_path)
+
+
+def test_zim_main_page(zim_fh: Archive):
+ """Ensure main page is a redirect to index.html"""
+
+ main_entry = zim_fh.main_entry
+ assert main_entry.is_redirect
+ assert main_entry.get_redirect_entry().path == "index.html"
+
+
+def test_zim_metadata(zim_fh: Archive):
+ """Ensure scraper and zim title are present in metadata"""
+
+ assert "libretexts2zim " in zim_fh.get_text_metadata("Scraper")
+ assert zim_fh.get_text_metadata("Title") == "GeoSciences courses"
+ assert (
+ zim_fh.get_text_metadata("Description") == "GeoSciences courses by LibreTexts"
+ )
+ assert zim_fh.get_text_metadata("Language") == "eng"
+ assert zim_fh.get_text_metadata("Publisher") == "openZIM"
+ assert zim_fh.get_text_metadata("Creator") == "LibreTexts"
+
+ # assert zim_fh.get_item("favicon.png").get_mimetype() == "image/png"
+ # assert zim_fh.get_item("index.html").get_mimetype() == "text/html"
+
+
+def test_zim_content_logo_png(zim_fh: Archive, home_png_size: int):
+ """Ensure proper content at content/logo.png"""
+
+ logo_png = zim_fh.get_item("content/logo.png")
+ assert logo_png.mimetype == "image/png" # pyright: ignore
+ assert len(logo_png.content) == home_png_size # pyright: ignore
+
+
+def test_zim_content_home_json(
+ zim_fh: Archive, home_welcome_text_paragraphs: list[str]
+):
+ """Ensure proper content at content/home.json"""
+
+ home_json = zim_fh.get_item("content/home.json")
+ assert home_json.mimetype == "application/json" # pyright: ignore
+ assert json.loads(bytes(home_json.content)) == { # pyright: ignore
+ "welcomeTextParagraphs": home_welcome_text_paragraphs
+ }
+
+
+def test_zim_content_shared_json(zim_fh: Archive):
+ """Ensure proper content at content/shared.json"""
+
+ shared_json = zim_fh.get_item("content/shared.json")
+ assert shared_json.mimetype == "application/json" # pyright: ignore
+ assert json.loads(bytes(shared_json.content)) == { # pyright: ignore
+ "logoPath": "content/logo.png"
+ }
+
+
+def test_zim_content_config_json(zim_fh: Archive):
+ """Ensure proper content at content/config.json"""
+
+ config_json = zim_fh.get_item("content/config.json")
+ assert config_json.mimetype == "application/json" # pyright: ignore
+ assert json.loads(bytes(config_json.content)) == { # pyright: ignore
+ "secondaryColor": "#FFFFFF"
+ }
diff --git a/scraper/tests/test_client.py b/scraper/tests/test_client.py
new file mode 100644
index 0000000..d047b0e
--- /dev/null
+++ b/scraper/tests/test_client.py
@@ -0,0 +1,57 @@
+import pytest
+
+from libretexts2zim.client import (
+ _get_soup, # pyright: ignore[reportPrivateUsage]
+ _get_welcome_text_from_home, # pyright: ignore[reportPrivateUsage]
+)
+
+
+@pytest.mark.parametrize(
+ "content,expected",
+ [
+ pytest.param(
+ (
+ r"""
+// drag(subject: string, options?: Partial): Chainable
+// dismiss(subject: string, options?: Partial): Chainable
+// visit(originalFn: CommandOriginalFn, url: string, options: Partial): Chainable
+// }
+// }
+// }
+
+export {}
diff --git a/zimui/cypress/support/e2e.ts b/zimui/cypress/support/e2e.ts
new file mode 100644
index 0000000..d68db96
--- /dev/null
+++ b/zimui/cypress/support/e2e.ts
@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
diff --git a/zimui/env.d.ts b/zimui/env.d.ts
new file mode 100644
index 0000000..11f02fe
--- /dev/null
+++ b/zimui/env.d.ts
@@ -0,0 +1 @@
+/// Vite App
+
+
+
+
+
+
diff --git a/zimui/package.json b/zimui/package.json
new file mode 100644
index 0000000..a9d2c2b
--- /dev/null
+++ b/zimui/package.json
@@ -0,0 +1,55 @@
+{
+ "name": "libretexts",
+ "version": "0.0.0",
+ "private": true,
+ "type": "module",
+ "scripts": {
+ "dev": "vite",
+ "build": "run-p type-check \"build-only {@}\" --",
+ "preview": "vite preview",
+ "test:unit": "vitest",
+ "test:unit:run": "vitest run",
+ "test:e2e": "start-server-and-test preview http://localhost:4173 'cypress run --e2e'",
+ "test:e2e:dev": "start-server-and-test 'vite dev --port 4173' http://localhost:4173 'cypress open --e2e'",
+ "build-only": "vite build",
+ "type-check": "vue-tsc --build --force",
+ "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
+ "format": "prettier --write src/"
+ },
+ "dependencies": {
+ "@fontsource/roboto": "^5.1.0",
+ "pinia": "^2.1.7",
+ "resize-observer-polyfill": "^1.5.1",
+ "vite-plugin-vuetify": "^2.0.4",
+ "vue": "^3.4.29",
+ "vue-router": "^4.3.3",
+ "vuetify": "^3.7.2"
+ },
+ "devDependencies": {
+ "@mdi/font": "^7.4.47",
+ "@pinia/testing": "^0.1.5",
+ "@rushstack/eslint-patch": "^1.8.0",
+ "@tsconfig/node20": "^20.1.4",
+ "@types/jsdom": "^21.1.7",
+ "@types/node": "^20.14.5",
+ "@vitejs/plugin-legacy": "^5.4.2",
+ "@vitejs/plugin-vue": "^5.0.5",
+ "@vue/eslint-config-prettier": "^9.0.0",
+ "@vue/eslint-config-typescript": "^13.0.0",
+ "@vue/test-utils": "^2.4.6",
+ "@vue/tsconfig": "^0.5.1",
+ "cypress": "^13.12.0",
+ "eslint": "^8.57.0",
+ "eslint-plugin-cypress": "^3.3.0",
+ "eslint-plugin-vue": "^9.23.0",
+ "jsdom": "^24.1.0",
+ "npm-run-all2": "^6.2.0",
+ "prettier": "^3.2.5",
+ "start-server-and-test": "^2.0.4",
+ "terser": "^5.34.0",
+ "typescript": "~5.4.0",
+ "vite": "^5.3.1",
+ "vitest": "^1.6.0",
+ "vue-tsc": "^2.0.21"
+ }
+}
diff --git a/zimui/public/favicon.ico b/zimui/public/favicon.ico
new file mode 100644
index 0000000..df36fcf
Binary files /dev/null and b/zimui/public/favicon.ico differ
diff --git a/zimui/src/App.vue b/zimui/src/App.vue
new file mode 100644
index 0000000..dde8207
--- /dev/null
+++ b/zimui/src/App.vue
@@ -0,0 +1,21 @@
+
+
+
+
+
+
+
+
diff --git a/zimui/src/assets/dead-kiwix.png b/zimui/src/assets/dead-kiwix.png
new file mode 100644
index 0000000..fc0beeb
Binary files /dev/null and b/zimui/src/assets/dead-kiwix.png differ
diff --git a/zimui/src/assets/logo-placeholder.png b/zimui/src/assets/logo-placeholder.png
new file mode 100644
index 0000000..28b47d4
Binary files /dev/null and b/zimui/src/assets/logo-placeholder.png differ
diff --git a/zimui/src/assets/main.css b/zimui/src/assets/main.css
new file mode 100644
index 0000000..b0da8c9
--- /dev/null
+++ b/zimui/src/assets/main.css
@@ -0,0 +1,126 @@
+* {
+ margin: 0;
+ padding: 0;
+}
+
+html {
+ overflow: auto !important;
+ font-family: 'Roboto', sans-serif;
+}
+
+a {
+ text-decoration: none;
+}
+
+:root {
+ font-synthesis: none;
+ text-rendering: optimizeLegibility;
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
+ -webkit-text-size-adjust: 100%;
+}
+
+.banner-bg .v-img__img--preload {
+ filter: none;
+}
+
+/* roboto-latin-100-normal */
+@font-face {
+ font-family: 'Roboto';
+ font-style: normal;
+ font-display: swap;
+ font-weight: 100;
+ src:
+ url(@fontsource/roboto/files/roboto-latin-100-normal.woff2) format('woff2'),
+ url(@fontsource/roboto/files/roboto-latin-100-normal.woff) format('woff');
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
+ U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
+ U+FFFD;
+}
+
+/* roboto-latin-300-normal */
+@font-face {
+ font-family: 'Roboto';
+ font-style: normal;
+ font-display: swap;
+ font-weight: 300;
+ src:
+ url(@fontsource/roboto/files/roboto-latin-300-normal.woff2) format('woff2'),
+ url(@fontsource/roboto/files/roboto-latin-300-normal.woff) format('woff');
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
+ U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
+ U+FFFD;
+}
+
+/* roboto-latin-400-normal */
+@font-face {
+ font-family: 'Roboto';
+ font-style: normal;
+ font-display: swap;
+ font-weight: 400;
+ src:
+ url(@fontsource/roboto/files/roboto-latin-400-normal.woff2) format('woff2'),
+ url(@fontsource/roboto/files/roboto-latin-400-normal.woff) format('woff');
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
+ U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
+ U+FFFD;
+}
+
+/* roboto-latin-500-normal */
+@font-face {
+ font-family: 'Roboto';
+ font-style: normal;
+ font-display: swap;
+ font-weight: 500;
+ src:
+ url(@fontsource/roboto/files/roboto-latin-500-normal.woff2) format('woff2'),
+ url(@fontsource/roboto/files/roboto-latin-500-normal.woff) format('woff');
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
+ U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
+ U+FFFD;
+}
+
+/* roboto-latin-700-normal */
+@font-face {
+ font-family: 'Roboto';
+ font-style: normal;
+ font-display: swap;
+ font-weight: 700;
+ src:
+ url(@fontsource/roboto/files/roboto-latin-700-normal.woff2) format('woff2'),
+ url(@fontsource/roboto/files/roboto-latin-700-normal.woff) format('woff');
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
+ U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
+ U+FFFD;
+}
+
+/* roboto-latin-900-normal */
+@font-face {
+ font-family: 'Roboto';
+ font-style: normal;
+ font-display: swap;
+ font-weight: 900;
+ src:
+ url(@fontsource/roboto/files/roboto-latin-900-normal.woff2) format('woff2'),
+ url(@fontsource/roboto/files/roboto-latin-900-normal.woff) format('woff');
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304,
+ U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF,
+ U+FFFD;
+}
+
+.v-btn {
+ display: flex !important;
+}
+
+.v-slide-group__content {
+ align-items: center;
+ justify-content: center;
+}
+
+.v-avatar img {
+ border-radius: 100%;
+}
+
+.v-btn__content > .v-icon--start {
+ margin-right: 0.5rem;
+}
diff --git a/zimui/src/components/ErrorDisplay.vue b/zimui/src/components/ErrorDisplay.vue
new file mode 100644
index 0000000..8f4b699
--- /dev/null
+++ b/zimui/src/components/ErrorDisplay.vue
@@ -0,0 +1,34 @@
+
+
+
+
+ Go back home
+
+
+
+
diff --git a/zimui/src/components/HeaderBar.vue b/zimui/src/components/HeaderBar.vue
new file mode 100644
index 0000000..749bb5a
--- /dev/null
+++ b/zimui/src/components/HeaderBar.vue
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+
diff --git a/zimui/src/components/__tests__/ErrorDisplay.spec.ts b/zimui/src/components/__tests__/ErrorDisplay.spec.ts
new file mode 100644
index 0000000..404d28b
--- /dev/null
+++ b/zimui/src/components/__tests__/ErrorDisplay.spec.ts
@@ -0,0 +1,32 @@
+import { describe, it, expect } from 'vitest'
+import { createVuetify } from 'vuetify'
+import * as components from 'vuetify/components'
+import * as directives from 'vuetify/directives'
+
+import { mount } from '@vue/test-utils'
+import { createTestingPinia } from '@pinia/testing'
+import ErrorDisplay from '../ErrorDisplay.vue'
+import { useMainStore } from '@/stores/main'
+import { vi } from 'vitest'
+const vuetify = createVuetify({
+ components,
+ directives
+})
+
+describe('ErrorDisplay', () => {
+ it('renders properly', () => {
+ const pinia = createTestingPinia({
+ createSpy: vi.fn
+ })
+ const main = useMainStore()
+ const errorMessage = "I've got an error"
+ main.errorMessage = errorMessage
+ const wrapper = mount(ErrorDisplay, {
+ global: {
+ plugins: [pinia, vuetify]
+ }
+ })
+ expect(wrapper.text()).toContain('Something went wrong')
+ expect(wrapper.text()).toContain('Go back home')
+ })
+})
diff --git a/zimui/src/components/__tests__/HeaderBar.spec.ts b/zimui/src/components/__tests__/HeaderBar.spec.ts
new file mode 100644
index 0000000..e8c9366
--- /dev/null
+++ b/zimui/src/components/__tests__/HeaderBar.spec.ts
@@ -0,0 +1,47 @@
+import { describe, it, expect } from 'vitest'
+import { createVuetify } from 'vuetify'
+import * as components from 'vuetify/components'
+import * as directives from 'vuetify/directives'
+
+import { mount } from '@vue/test-utils'
+import { createTestingPinia } from '@pinia/testing'
+import HeaderBar from '../HeaderBar.vue'
+import { useMainStore } from '@/stores/main'
+import { vi } from 'vitest'
+const vuetify = createVuetify({
+ components,
+ directives
+})
+
+describe('HeaderBar', () => {
+ it('renders properly with default placeholder', () => {
+ const pinia = createTestingPinia({
+ createSpy: vi.fn
+ })
+ const wrapper = mount(HeaderBar, {
+ global: {
+ plugins: [pinia, vuetify]
+ }
+ })
+ const img = wrapper.find('img')
+ expect(img.exists()).toBe(true)
+ expect(img.attributes('src')).toBe('/src/assets/logo-placeholder.png')
+ }),
+ it('renders properly with shared data', () => {
+ const pinia = createTestingPinia({
+ createSpy: vi.fn
+ })
+ const main = useMainStore()
+ const logoPath = 'content/logo.png'
+ main.shared = { logoPath: logoPath }
+
+ const wrapper = mount(HeaderBar, {
+ global: {
+ plugins: [pinia, vuetify]
+ }
+ })
+ const img = wrapper.find('img')
+ expect(img.exists()).toBe(true)
+ expect(img.attributes('src')).toBe(logoPath)
+ })
+})
diff --git a/zimui/src/main.ts b/zimui/src/main.ts
new file mode 100644
index 0000000..5531a32
--- /dev/null
+++ b/zimui/src/main.ts
@@ -0,0 +1,27 @@
+import './assets/main.css'
+
+import { createApp } from 'vue'
+import { createPinia } from 'pinia'
+
+import App from './App.vue'
+import router from './router'
+import loadVuetify from './plugins/vuetify'
+
+import ResizeObserver from 'resize-observer-polyfill'
+
+if (typeof window.ResizeObserver === 'undefined') {
+ console.debug('Polyfilling ResizeObserver')
+ window.ResizeObserver = ResizeObserver
+}
+
+loadVuetify()
+ .then((vuetify) => {
+ const app = createApp(App)
+ app.use(createPinia())
+ app.use(vuetify)
+ app.use(router)
+ app.mount('#app')
+ })
+ .catch((error) => {
+ console.error('Error initializing app:', error)
+ })
diff --git a/zimui/src/plugins/vuetify.ts b/zimui/src/plugins/vuetify.ts
new file mode 100644
index 0000000..a239a8e
--- /dev/null
+++ b/zimui/src/plugins/vuetify.ts
@@ -0,0 +1,47 @@
+import 'vuetify/styles'
+import '@mdi/font/css/materialdesignicons.css'
+import axios from 'axios'
+import { createVuetify } from 'vuetify'
+import type { Config } from '@/types/config'
+
+async function loadVuetify() {
+ const primaryColor = '#000000'
+ let secondaryColor = '#FFFFFF'
+
+ // Load secondary colors from config.json
+ try {
+ const response = await axios.get('./content/config.json')
+ if (response.status === axios.HttpStatusCode.Ok) {
+ const config: Config = response.data
+ secondaryColor = config.secondaryColor || secondaryColor
+ } else {
+ console.error('Failed to fetch config.json')
+ }
+ } catch (error) {
+ console.error('Error loading config:', error)
+ }
+
+ const zimuiTheme = {
+ colors: {
+ background: secondaryColor,
+ surface: secondaryColor,
+ primary: primaryColor
+ }
+ }
+
+ return createVuetify({
+ theme: {
+ defaultTheme: 'zimuiTheme',
+ variations: {
+ colors: ['background', 'primary'],
+ lighten: 2,
+ darken: 2
+ },
+ themes: {
+ zimuiTheme
+ }
+ }
+ })
+}
+
+export default loadVuetify
diff --git a/zimui/src/router/index.ts b/zimui/src/router/index.ts
new file mode 100644
index 0000000..85203d9
--- /dev/null
+++ b/zimui/src/router/index.ts
@@ -0,0 +1,18 @@
+import { createRouter, createWebHashHistory } from 'vue-router'
+import HomeView from '../views/HomeView.vue'
+
+const router = createRouter({
+ history: createWebHashHistory(),
+ routes: [
+ {
+ path: '/',
+ name: 'home',
+ component: HomeView
+ }
+ ],
+ scrollBehavior() {
+ return { top: 0, behavior: 'smooth' }
+ }
+})
+
+export default router
diff --git a/zimui/src/stores/counter.ts b/zimui/src/stores/counter.ts
new file mode 100644
index 0000000..b6757ba
--- /dev/null
+++ b/zimui/src/stores/counter.ts
@@ -0,0 +1,12 @@
+import { ref, computed } from 'vue'
+import { defineStore } from 'pinia'
+
+export const useCounterStore = defineStore('counter', () => {
+ const count = ref(0)
+ const doubleCount = computed(() => count.value * 2)
+ function increment() {
+ count.value++
+ }
+
+ return { count, doubleCount, increment }
+})
diff --git a/zimui/src/stores/home.ts b/zimui/src/stores/home.ts
new file mode 100644
index 0000000..049bd28
--- /dev/null
+++ b/zimui/src/stores/home.ts
@@ -0,0 +1,43 @@
+import { defineStore } from 'pinia'
+import axios, { AxiosError } from 'axios'
+import type { Home } from '@/types/home'
+import { useMainStore } from './main'
+
+export type RootState = {
+ home: Home | null
+}
+
+export const useHomeStore = defineStore('home', {
+ state: () =>
+ ({
+ home: null
+ }) as RootState,
+ getters: {},
+ actions: {
+ async fetchHome() {
+ const main = useMainStore()
+ main.isLoading = true
+ main.errorMessage = ''
+ main.errorDetails = ''
+
+ return axios.get('./content/home.json').then(
+ (response) => {
+ main.isLoading = false
+ this.home = response.data as Home
+ },
+ (error) => {
+ main.isLoading = false
+ this.home = null
+ main.errorMessage = 'Failed to load home data.'
+ if (error instanceof AxiosError) {
+ main.handleAxiosError(error)
+ }
+ }
+ )
+ },
+ setErrorMessage(message: string) {
+ const main = useMainStore()
+ main.errorMessage = message
+ }
+ }
+})
diff --git a/zimui/src/stores/main.ts b/zimui/src/stores/main.ts
new file mode 100644
index 0000000..07fbff2
--- /dev/null
+++ b/zimui/src/stores/main.ts
@@ -0,0 +1,73 @@
+import { defineStore } from 'pinia'
+import axios, { AxiosError } from 'axios'
+import type { Shared } from '@/types/shared'
+
+export type RootState = {
+ shared: Shared | null
+ isLoading: boolean
+ errorMessage: string
+ errorDetails: string
+}
+
+export const useMainStore = defineStore('main', {
+ state: () =>
+ ({
+ shared: null,
+ isLoading: false,
+ errorMessage: '',
+ errorDetails: ''
+ }) as RootState,
+ getters: {},
+ actions: {
+ async fetchShared() {
+ this.isLoading = true
+ this.errorMessage = ''
+ this.errorDetails = ''
+
+ return axios.get('./content/shared.json').then(
+ (response) => {
+ this.isLoading = false
+ this.shared = response.data as Shared
+ },
+ (error) => {
+ this.isLoading = false
+ this.shared = null
+ this.errorMessage = 'Failed to load shared data.'
+ if (error instanceof AxiosError) {
+ this.handleAxiosError(error)
+ }
+ }
+ )
+ },
+ checkResponseObject(response: unknown, msg: string = '') {
+ if (response === null || typeof response !== 'object') {
+ if (msg !== '') {
+ this.errorDetails = msg
+ }
+ throw new Error('Invalid response object.')
+ }
+ },
+ handleAxiosError(error: AxiosError
Welcome to the """ + r"""Geosciences Library
Welcome to the """ + r"""Geosciences Library
Welcome to the """ + r"""Geosciences Library
This is a second paragraph
""" + r"""Welcome to the """ + r"""Geosciences Library
Welcome to the """ + r"""Geosciences Library
Hello
"""
+ r"""Hello
+
+
+
+