The snap-core package

[Tags: bsd3, library]

Snap is a simple and fast web development framework and server written in Haskell. For more information or to download the latest version, you can visit the Snap project website at http://snapframework.com/.

This library contains the core definitions and types for the Snap framework, including:

1. Primitive types and functions for HTTP (requests, responses, cookies, post/query parameters, etc)

2. Type aliases and helper functions for Iteratee I/O

3. A monad for programming web handlers called "Snap", inspired by happstack's (http://happstack.com/index.html), which allows:

Quick start: The Snap monad and HTTP definitions are in Snap.Types, some iteratee utilities are in Snap.Iteratee.

Higher-level facilities for building web applications (like user/session management, component interfaces, data modeling, etc.) are planned but not yet implemented, so this release will mostly be of interest for those who:


[Skip to ReadMe]

Properties

Versions0.1.1, 0.1.2, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.2.6, 0.2.7, 0.2.7.1, 0.2.8, 0.2.8.1, 0.2.9, 0.2.10, 0.2.11, 0.2.12, 0.2.13, 0.2.14, 0.2.15, 0.2.15.1, 0.2.16, 0.3.0, 0.3.1, 0.3.1.1, 0.4.0, 0.4.0.1, 0.4.0.2, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.5.1, 0.5.1.1, 0.5.1.2, 0.5.1.3, 0.5.1.4, 0.5.2, 0.5.3, 0.5.3.1, 0.5.4, 0.5.5, 0.6.0, 0.6.0.1, 0.7, 0.7.0.1, 0.8.0, 0.8.0.1, 0.8.1, 0.9.0, 0.9.2, 0.9.2.1, 0.9.2.2, 0.9.3, 0.9.3.1, 0.9.4.0, 0.9.4.1, 0.9.5.0, 0.9.6.0, 0.9.6.1, 0.9.6.2, 0.9.6.3, 0.9.6.4, 0.9.7.0, 0.9.7.2
Change logNone available
Dependenciesattoparsec (>=0.8.0.2 && <0.10), attoparsec-enumerator (>=0.2.0.3), base (>=4.3 && <5), blaze-builder (>=0.2.1.4 && <0.4), bytestring, bytestring-mmap (>=0.2.2 && <0.3), bytestring-nums, case-insensitive (>=0.2 && <0.4), containers, deepseq (>=1.1 && <1.3), directory, dlist (==0.5.*), enumerator (>=0.4.13.1 && <0.5), filepath, MonadCatchIO-transformers (>=0.2.1 && <0.3), mtl (==2.0.*), old-locale, old-time, text (==0.11.*), time (>=1.0 && <1.4), transformers (==0.2.*), unix (>=2.4 && <3.0), unix-compat (>=0.2 && <0.4), vector (>=0.6 && <0.10), zlib [details]
LicenseBSD3
AuthorJames Sanders, Shu-yu Guo, Gregory Collins, Doug Beardsley
Maintainersnap@snapframework.com
CategoryWeb
Home pagehttp://snapframework.com/
Source repositoryhead: git clone git://github.com/snapframework/snap-core.git
UploadedMon Sep 12 12:39:43 UTC 2011 by GregoryCollins
DistributionsDebian:0.9.7.2, Fedora:0.9.6.4, FreeBSD:0.9.6.3, LTSHaskell:0.9.7.2, NixOS:0.9.7.2, Stackage:0.9.7.2
Downloads35001 total (1233 in last 30 days)
Votes
2 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Flags

NameDescriptionDefault
portableCompile in cross-platform mode. No platform-specific code or optimizations such as C routines will be used.Disabled
debugEnable debug logging code. With this flag, Snap will test the DEBUG environment variable to decide whether to do logging, and this introduces a tiny amount of overhead (a call into a function pointer) because the calls to 'debug' cannot be inlined.Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for snap-core-0.5.4

Snap Framework Core

This is the first developer prerelease of the Snap Framework Core library. For more information about Snap, read the README.SNAP.md or visit the Snap project website at http://www.snapframework.com/.

Snap is a nascent web framework for Haskell, based on iteratee I/O (as popularized by Oleg Kiselyov).

Library contents

This is the snap-core library, which contains:

Building snap-core

The snap-core library is built using Cabal and Hackage. Just run

cabal install

from the snap-core toplevel directory.

Building the Haddock Documentation

The haddock documentation can be built using the supplied haddock.sh shell script:

./haddock.sh

The docs get put in dist/doc/html/.

Building the testsuite

Snap is still in its very early stages, so most of the "action" (and a big chunk of the code) right now is centred on the test suite. Snap aims for 100% test coverage, and we're trying hard to stick to that.

To build the test suite, cd into the test/ directory and run

$ cabal configure
$ cabal build

From here you can invoke the testsuite by running:

$ ./runTestsAndCoverage.sh 

The testsuite generates an hpc test coverage report in test/dist/hpc.