The scotty package

[ Tags: bsd3, library, web ] [ Propose Tags ]

A Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp.

{-# LANGUAGE OverloadedStrings #-}

import Web.Scotty

import Data.Monoid (mconcat)

main = scotty 3000 $ do
  get "/:word" $ do
    beam <- param "word"
    html $ mconcat ["<h1>Scotty, ", beam, " me up!</h1>"]

Scotty is the cheap and cheerful way to write RESTful, declarative web applications.

A page is as simple as defining the verb, url pattern, and Text content.
It is template-language agnostic. Anything that returns a Text value will do.
Conforms to WAI Application interface.
Uses very fast Warp webserver by default.

As for the name: Sinatra + Warp = Scotty.

WAI: http://hackage.haskell.org/package/wai
Warp: http://hackage.haskell.org/package/warp

[Skip to Readme]

Properties

Versions	0.0.1, 0.1.0, 0.2.0, 0.3.0, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4, 0.4.5, 0.4.6, 0.5.0, 0.6.0, 0.6.1, 0.6.2, 0.7.0, 0.7.1, 0.7.2, 0.7.3, 0.8.0, 0.8.1, 0.8.2, 0.9.0, 0.9.1, 0.10.0, 0.10.1, 0.10.2, 0.11.0 (info)
Dependencies	aeson (==0.6.0.2), base (>=4.3.1 && <5), blaze-builder (==0.3.1.0), bytestring (==0.9.1), case-insensitive (==0.4.0.3), conduit (==0.5.2.7), data-default (==0.5.0), http-types (==0.7.3.0.1), mtl (==2.1.2), regex-compat (==0.95.1), resourcet (==0.4.0.2), text (==0.11.2.3), wai (==1.3.0.1), wai-extra (==1.3.0.3), warp (==1.3.4.1) [details]
License	BSD3
Copyright	(c) 2012 Andrew Farmer
Author	Andrew Farmer <anfarmer@ku.edu>
Maintainer	Andrew Farmer <anfarmer@ku.edu>
Category	Web
Home page	https://github.com/ku-fpg/scotty
Bug tracker	https://github.com/ku-fpg/scotty/issues
Source repository	head: git clone git://github.com/ku-fpg/scotty.git
Uploaded	Thu Oct 25 21:54:53 UTC 2012 by AndrewFarmer
Updated	Tue Jan 6 19:32:58 UTC 2015 by AndrewFarmer to revision 1
Distributions	Fedora:0.11.0, LTSHaskell:0.11.0, NixOS:0.11.0, Stackage:0.11.0, Tumbleweed:0.11.0
Downloads	23434 total (73 in the last 30 days)
Rating	0.0 (0 ratings) [clear rating] λ λ λ
Status	Docs uploaded by user Build status unknown [no reports yet] Hackage Matrix CI

Modules

Web
- Web.Scotty

[Index]

Downloads

scotty-0.4.6.tar.gz [browse] (Cabal source package)
Package description (included in the package)

Maintainer's Corner

For package maintainers and hackage trustees

edit package information

Readme for scotty-0.4.6

[back to package description]

Scotty
======

A Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp.

  {-# LANGUAGE OverloadedStrings #-}
  import Web.Scotty

  import Data.Monoid (mconcat)

  main = scotty 3000 $ do
    get "/:word" $ do
      beam <- param "word"
      html $ mconcat ["<h1>Scotty, ", beam, " me up!</h1>"]

Scotty is the cheap and cheerful way to write RESTful, declarative web applications.

  * A page is as simple as defining the verb, url pattern, and Text content.
  * It is template-language agnostic. Anything that returns a Text value will do.
  * Conforms to WAI Application interface.
  * Uses very fast Warp webserver by default.

See examples/basic.hs to see Scotty in action. (basic.hs needs the wai-extra package)

    > runghc examples/basic.hs
    Setting phasers to stun... (ctrl-c to quit)
    (visit localhost:3000/somepath)

This design has been done in Haskell at least once before (to my knowledge) by
the miku framework. My issue with miku is that it uses the Hack2 interface
instead of WAI (they are analogous, but the latter seems to have more traction),
and that it is written using a custom prelude called Air (which appears to be an
attempt to turn Haskell into Ruby syntactically). I wanted something that
depends on relatively few other packages, with an API that fits on one page.

As for the name: Sinatra + Warp = Scotty.

Copyright (c) 2012 Andrew Farmer