let-me-scroll-it 0.0.5

A command-line utility for placing figures in a static webpage

Let Me Scroll It (lmsi)

lmsi is a command-line utility that produces a html web-page. This web-page contains the images you provide the command-line utility. It is available on PyPI:

pip install let-me-scroll-it

(lmsi was not allowed by PyPI, unfortunately...)

You can configure sections, titles for plots, and captions, using the JSON configuration file of the form:

{
  "Section Name": {
    "[0-9]*_.*png": {
      "caption": "A figure selected using regex. I can use MathJax $x^2 = 3$.",
      "title": "Regex Selection",
      "regex": true
    },
    "no_regex_required.png": {
      "caption": "No regex requried for this, just searched on the filename.",
      "title": "Fixed Name Selection"
    }
  }
}

You can use regex here or just a plain string. If you want the string to be interpreted as a regular expression, you must use the "regex": true option.

There is an example in the example directory.

You can use the utility as follows:

lmsi --files *.png --output index.html --config /path/to/config.json

Using lmsi without a config leads to all figures being placed in the 'uncategorised' section.

Licensing

lmsi contains a bundled copy of the MathJax library, which is licensed with the Apache 2.0 library.

lmsi contains a bundled copy of the polyfill.js library, which is licensed with the MIT license.

The rest of the source code, produced by the lmsi authors, is MIT-licensed.