This pull request replaces the functionality of the existing setup script script.sh with an OS-agnostic Python file named dse_setup.py. This allows for an OS-agnosctic utilization of the dse-static-cookiecutter template, thus enhancing its accessibility and usability across different platforms.
Motivation
During my internship at the ACDH in February, I observed that some of my colleagues encountered challenges setting up a static site with the dse-static-cookiecutter template. These challenges stemmed from either a lack of familiarity with Linux systems or a lack of feedback provided by the existing script. This pull request aims to simplify the setup process and making it more user-friendly.
Key Features
Implementation of an OS-agnostic Python script (dse_setup.py) using only standard Python libraries, eliminating the need for external dependencies.
Error handling and logging to address issues encountered during dependency downloads or directory operations such as renaming and deletion.
Externalization of configurable parameters such as download URLs and folder names into a config.ini file, allowing for easier changes and cutomizations of script parameters.
Usage
python dse_setup.py -a [action]
Options:
-a, --action: Specifies the action to execute.
Choices: "dd" (Download Dependencies), "bi" (Build Index), "fd" (Fetch Data)
Download Dependencies (dd):
Downloads required dependencies including imprint XML files, Saxon HE (Home Edition), and optionally, the static search tool along with its stopwords list.
Build Index (bi):
Initiates the process to build the static-search index based on the configured settings.
Fetch Data (fd):
Fetches transcriptions from the specified data repository.
Additional Information
Static-search support for Windows is still in a development branch (Link to PR), slated for inclusion in Release 2.0. Consequently, the script detects Windows environments and fetches the development branch from the staticsearch GitHub page. This experimental Windows support necessitates the inclusion of a separate ss_config_windows.xml file, reflecting changes in the development branch (Link to Issue).
Windows support is thus considered experimental but functional.
The script has been tested on Windows 11 and Ubuntu Linux 23.10.
The config.ini file allows for easier adaptation to future changes in download paths once the official release of staticsearch 2.0 is available.
Resolves #46
This pull request replaces the functionality of the existing setup script
script.shwith an OS-agnostic Python file nameddse_setup.py. This allows for an OS-agnosctic utilization of the dse-static-cookiecutter template, thus enhancing its accessibility and usability across different platforms.Motivation
During my internship at the ACDH in February, I observed that some of my colleagues encountered challenges setting up a static site with the dse-static-cookiecutter template. These challenges stemmed from either a lack of familiarity with Linux systems or a lack of feedback provided by the existing script. This pull request aims to simplify the setup process and making it more user-friendly.
Key Features
config.inifile, allowing for easier changes and cutomizations of script parameters.Usage
Options:
Download Dependencies (dd): Downloads required dependencies including imprint XML files, Saxon HE (Home Edition), and optionally, the static search tool along with its stopwords list.
Build Index (bi): Initiates the process to build the static-search index based on the configured settings.
Fetch Data (fd): Fetches transcriptions from the specified data repository.
Additional Information
Static-search support for Windows is still in a development branch (Link to PR), slated for inclusion in Release 2.0. Consequently, the script detects Windows environments and fetches the development branch from the staticsearch GitHub page. This experimental Windows support necessitates the inclusion of a separate
ss_config_windows.xmlfile, reflecting changes in the development branch (Link to Issue).Windows support is thus considered experimental but functional. The script has been tested on Windows 11 and Ubuntu Linux 23.10.
The config.ini file allows for easier adaptation to future changes in download paths once the official release of staticsearch 2.0 is available.