Git Product home page Git Product logo

spiderman's Introduction

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.

spiderman's People

Contributors

juselius avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

simonleary42

spiderman's Issues

With what stack did this compile?

I'm trying to build this but I keep getting the following error:

$ cabal update
Downloading the latest package list from hackage.haskell.org 
$ cabal install
cabal: internal error when reading package index: failed to parse .cabal
fileThe package index or index cache is probably corrupt. Running cabal update
might fix it.

I tried ubuntu 14.04, 16.04, 18.04, and then with 20.04 it stopped making that error. Then it got a bunch of compiler errors due to type checking. spiderman.cabal doesn't specify versions on any of its dependencies so I'm assuming cabal installed the latest packages which are no longer compatible.

On what OS did this compile? Using what version of Haskell?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.