hg.stevelosh.com > docs.stevelosh.com

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN"
    "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
      xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
          xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
          xmlns:dc="http://purl.org/dc/elements/1.1/"
          xmlns:foaf="http://xmlns.com/foaf/0.1/">

      <head>


                <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />


            <title>
                Garter »
                Garter
            </title>


                <!-- YUI CSS reset, fonts, base -->
                <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/combo?3.0.0/build/cssreset/reset-min.css&amp;3.0.0/build/cssfonts/fonts-min.css&amp;3.0.0/build/cssbase/base-min.css" media="screen, projection" />

                <link rel="stylesheet" type="text/css" href="media/css/style.css" media="screen, projection" />
                <link rel="stylesheet" type="text/css" href="media/css/pygments.css" media="screen, projection" />
                <link rel="stylesheet" type="text/css" href="media/css/garter.css" media="screen, projection" />


    </head>

    <body >


    <ol id="breadcrumbs">

        <li class="crumb-0 last">

            index

        </li>

    </ol> <!-- ol#breadcrumbs -->


            <div id="content">


                <h1 id="splash-logo">Garter</h1>

<div id="logo">
    <a href=""><img src="http://sjl.bitbucket.org/garter/media/images/logo.png"/></a>
</div>

<p><a href="http://sjl.bitbucket.org/garter/">Garter</a> is a collection of small utilities that makes creating webapps with
<a href="http://flask.pocoo.org/">Flask</a> easier.</p>
<p>Flask is a wonderful little web framework, but sometimes you need
<a href="http://en.wikipedia.org/wiki/File:Mlle._Rhea_Flask_LC-USZ62-99952.jpg">a garter</a> to get your webapp working in the big old <a href="http://en.wikipedia.org/wiki/Speakeasy">speakeasy</a> that
is the Internet.</p>
<div class="toc">
<ul>
<li><a href="#installing">Installing</a></li>
<li><a href="#using">Using</a><ul>
<li><a href="#csrf-protectioncsrf"><a href="csrf.html">CSRF Protection</a></a></li>
<li><a href="#lesscss-supportlesscss"><a href="lesscss.html">LessCSS Support</a></a></li>
<li><a href="#url-convenience-functionsurls"><a href="urls.html">URL Convenience Functions</a></a></li>
</ul>
</li>
<li><a href="#contributing">Contributing</a></li>
</ul>
</div>
<h2 id="installing">Installing</h2>
<p>Use <a href="http://pip.openplans.org/">pip</a> to install Garter:</p>
<div class="codehilite"><pre>pip install -e hg+http://bitbucket.org/sjl/garter/#egg=garter
</pre></div>


<p>Prefer <a href="http://git-scm.com/">git</a> to <a href="http://hg-scm.org/">Mercurial</a>?</p>
<div class="codehilite"><pre>pip install -e git+http://github.com/sjl/garter.git#egg=garter
</pre></div>


<p>You can install it without pip, but why would you want to?</p>
<div class="codehilite"><pre>hg clone http://bitbucket.org/sjl/garter/
cd garter
python setup.py install
</pre></div>


<h2 id="using">Using</h2>
<p>Garter contains a bunch of useful little functions. Use the ones you need,
ignore the rest.</p>
<h3 id="csrf-protectioncsrf"><a href="csrf.html">CSRF Protection</a></h3>
<h3 id="lesscss-supportlesscss"><a href="lesscss.html">LessCSS Support</a></h3>
<h3 id="url-convenience-functionsurls"><a href="urls.html">URL Convenience Functions</a></h3>
<h2 id="contributing">Contributing</h2>
<p>Want to contribute your own useful functions?  Fork the
<a href="http://bitbucket.org/sjl/garter/">Mercurial repository</a> or <a href="http://github.com/sjl/garter/">git repository</a> and send a
pull request.</p>
<p>Make sure you update the documentation to mention your changes!</p>


                <hr class="clear" />
            </div>


                <div id="footer">
                    <p>
                        <a href="http://sjl.bitbucket.org/garter/">Garter</a>
                        was lovingly crafted by
                        <a href="http://stevelosh.com/">Steve Losh</a>.
                        The documentation is powered by
                        <a href="http://markdoc.org/">Markdoc</a>.
                    </p>
                </div>


        <hr class="clear" />
    </body>
</html>
author	Steve Losh <steve@stevelosh.com>
date	Tue, 11 May 2010 21:12:41 -0400
parents	84e309e1aa3a
children	(none)