https://github.com/jborrow/lmsi
https://github.com/jborrow/lmsi
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jborrow/lmsi
- Owner: JBorrow
- License: mit
- Created: 2024-09-13T22:06:34.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T12:25:15.000Z (8 months ago)
- Last Synced: 2024-12-27T06:41:26.671Z (5 months ago)
- Language: Python
- Size: 495 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
```json
{
"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](https://github.com/mathjax/MathJax)
library, which is licensed with the Apache 2.0 library.
`lmsi` contains a bundled copy of the [polyfill.js](https://philipwalton.github.io/polyfill/)
library, which is licensed with the MIT license.
The rest of the source code, produced by the `lmsi` authors, is MIT-licensed.