archive-fandom-wiki/README.org

#+title: archive-fandom-wiki

This program archives the content of fandom wikis. It doesn't scrape from the fandom.com wiki sites directly; rather, it uses my [[https://breezewiki.hyperreal.coffee][BreezeWiki]] instance to avoid downloading unnecessary ads, images, and other junk.

Each resulting archive is self-contained, meaning one can extract the contents and browse the wiki snapshot locally (offline). The URLs for CSS, images, and links in each page are replaced by the relative ~file:///~ URLs for their corresponding pages on the local filesystem.

** Installation

Make sure Python and Pip are installed. Then run:
#+begin_src bash
git clone https://codeberg.org/hyperreal/archive-fandom-wiki.git
cd archive-fandom-wiki
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
#+end_src

If not using venv:
#+BEGIN_SRC bash
pip install --user -r requirements.txt
ln -sf "$(pwd)/afw.py" ~/.local/bin/afw
#+END_SRC

** Usage
One may specify the BreezeWiki instance URL, or the default value (my BreezeWiki instance URL) will be used.
#+begin_src bash
afw dishonored https://breezewiki.instance.url
afw dishonored
#+end_src

** Podman/Docker
There is also a Containerfile, also known as a Dockerfile.
#+begin_src bash
git clone https://codeberg.org/hyperreal/archive-fandom-wiki
cd archive-fandom-wiki
podman build -t localhost/archive-fandom-wiki:latest .
#+end_src

To run the container image:
#+begin_src bash
podman run --name archive-fandom-wiki --rm -v "${HOME}/archives:/output:Z" localhost/archive-fandom-wiki dishonored
#+end_src