JUSTME.WEBSITE BACKUP - README
===============================

What is this?
--------------
An app that creates an epub backup of a chosen month from a WordPress
site (defaults to justme.website, but you can change it): all posts,
text, formatting, and images from that month bundled into a single
epub file you can keep yourself.

For: Linux Mint and Debian (and most other Ubuntu/Debian-based
systems, such as Ubuntu itself and Pop!_OS).


INSTALLING (one time only)
---------------------------
1. Extract this zip file into a folder you want to keep, for example:
   ~/Apps/justme-backup-linux

   (Don't move the folder after installing - the shortcut points to
   this location.)

2. Open a terminal in that folder. Usually you can do this by
   right-clicking in your file manager and choosing "Open Terminal
   Here", or by navigating there in a terminal with "cd".

3. Run the following two commands:

     chmod +x install.sh
     ./install.sh

   This installs the required system packages (you'll be asked for
   your password), sets up a dedicated Python environment so nothing
   else on your system is affected, and adds a shortcut to your
   applications menu.

4. Done. You only need to do this once.


USING THE APP
--------------
Option A: search your applications menu for "JustMe" and click
          "JustMe.website Backup".

Option B: open a terminal in the app folder and run:
          ./run.sh

In the window that opens:
1. The website address is pre-filled with justme.website. To back up
   a different WordPress site, enter that address instead.
2. Choose the month and year.
3. Choose the folder where the epub should be saved (default:
   ~/justme-backups).
4. Click "Create backup" and watch the progress at the bottom of the
   window.
5. Once it's done, the epub file will be in the folder you chose. You
   can open it with any epub reader (e.g. Calibre, or the Books app
   on your phone).


FREQUENTLY ASKED QUESTIONS
---------------------------
Q: Can I have this run automatically every month, without opening the
   window?
A: Yes. See justme_backup.py (the "plain" script without a window) -
   you can schedule that with cron to run automatically every month.
   Just ask if you'd like help setting that up.

Q: The installer asks for my password, is that safe?
A: That's sudo, needed to install the python3-tk system package (for
   the window). This is a normal and safe part of software management
   on Linux, similar to "apt install" you may already know.

Q: I get an error that a site couldn't be reached.
A: Check that the address is correct and that the site is a regular
   WordPress site with the standard REST API available (you can check
   this by adding /wp-json/ to the end of the address in your
   browser - if you see text/JSON appear, it should work).

Q: Can I remove the app?
A: Delete the folder you extracted it into, and delete the file
   ~/.local/share/applications/justme-backup.desktop.


FILES IN THIS ZIP
------------------
justme_backup.py       - the core logic (can also be used on its own
                          from the terminal, e.g. for an automatic
                          cron job)
justme_backup_gui.py    - the window used to operate the app
requirements.txt        - list of required Python packages
install.sh               - one-time install script
run.sh                    - created by install.sh, starts the app
README.txt                - this file
