phimages

A Python script which checks if the images referred to in a lesson document (.md) actually exist in an images directory, and whether their naming scheme conforms to The Programming Historian (PH) standards.

Requirements

Python 3.6+
Click 8.0+

Run:

pip install -r requirements.txt

to install all package requirements.

Click is needed for the CLI. To install it you can either:

use PIP: pip install --user click
use your system's package manager (e.g. on Arch Linux you can run: sudo pacman -S python-click)

For more details see here

Installation

Clone this repo (git clone https://github.com/nivaca/phimages) and symlink to your user's bin directory (or to anywhere your PATH variable points to).

You can also download the latest release directly from GitHub and unzip it. Place it wherever you want to access it.

Usage

To run the script type this in the terminal:

python3 phimages.py <lessonfile.md> --imgdir <imagesdirectory/>

Available options are:

  --listimages   Lists all image references in the document and all images in
                 the image directory.
  --version      Displays the script version.
  --checkonly    Only check the files.
  --mkbkp        Backup all files it changes/renames.  [default: True]
  --dryrun       Dry run (do not make any changes).  [default: False]
  --imgdir TEXT  Image directory  [default: img/]
  --help         Show this message and exit.

For instance:

python3 ~/dev/Python/phimages/phimages.py fichas-lectura-cod-imagenes.md --imgdir ~/editions/PH/ph-submissions/images/fichas-zotero --dryrun

License

Released under CC-BY-NC-SA 4.0 license.

Bugs etc.

Please create a GitHub issue, including the script version. (You can look it up with the --version option.)

Version history

0.1 (2021-10-04): first release

mariajoafana/phimages