Skip to content

juselius/spiderman

Repository files navigation

SpiderMan

Convert Lmod's spider -o softwarePage JSON into HTML pages.

Features

  • Filter output on category and keywords
  • Renders HTML via easily customizable StringTemplates
  • Generate reStructuredText output
  • Generate .page rst files for gitit
  • Generate MetaDoc software page xml

Quick start

Make sure you have Haskell Platform installed:

Install the prerequisites:

$ cabal update
$ cabal install --only-dependencies

Run SiderMan:

$ runhaskell SpiderMan.hs --help
$ ./examples/runspider.sh /path/to/modulefiles/{Core,Apps,...} > modules.json
$ runhaskell SpiderMan.hs modules.json
$ xdg-open modules/index.html

If you want to nicely formatted pages, you need to install the files in data/css, together with the generated output on a web server.

Building

For better performance and faster startup you might want to compile and install spiderman (see the cabal documentation for the details):

$ cabal install
or
$ sudo cabal install --global

Disclaimer

This program should probably have been written in Lua or Python. But I needed to learn Haskell, so it's written in Haskell. Complaints are accepted in hardcopy only. Besides, Haskell is a fantastic language.

About

Convert Lmod JSON to HTML, RST or MetaDoc XML

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published