django-hoptoad/installation/index.html @ 82488ceb5054

hg-prompt: Update documentation.
author Steve Losh <steve@stevelosh.com>
date Fri, 08 Jan 2010 20:12:54 -0500
parents 825cda6146fa
children 50444dfe7265
<?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>
      django-hoptoad » Installation
    </title>
    
    <link rel="stylesheet" type="text/css" href="../media/css/reset.css" media="screen, projection" />
    <link rel="stylesheet" type="text/css" href="../media/css/layout.css" media="screen, projection" />
    <link rel="stylesheet" type="text/css" href="../media/css/typography.css" media="screen, projection" />
    <link rel="stylesheet" type="text/css" href="../media/css/pygments.css" media="screen, projection" />
  </head>
  
  <body>
    <div id="content">

      
        <div id="breadcrumbs">
          <p>
              
                
                  <a href="../">index</a> &#187;
                
              
                
                  installation
                
              
          </p>
        </div> <!-- div#breadcrumbs -->
      
      
      
  <h1 id="installation">Installation</h1>
<p>django-hoptoad requires:</p>
<ul>
<li><a href="http://python.org/">Python</a> 2.5+ (preferably 2.6+ as that's what I've tested it with)</li>
<li><a href="http://pyyaml.org/">PyYAML</a> (<code>pip install pyyaml</code> or <code>easy_install pyyaml</code>)</li>
<li><a href="http://djangoproject.com/">Django</a> 1.0+</li>
<li>A <a href="http://hoptoadapp.com/">Hoptoad</a> account</li>
</ul>
<p>Grab the the <code>django-hoptoad</code> code by cloning the <a href="http://mercurial.selenic.com/">Mercurial</a> repository (or just <a href="http://bitbucket.org/sjl/django-hoptoad/get/tip.zip">download the latest version</a> and unzip it somewhere):</p>
<div class="codehilite"><pre><span class="n">hg</span> <span class="n">clone</span> <span class="n">http:</span><span class="sr">//</span><span class="n">bitbucket</span><span class="o">.</span><span class="n">org</span><span class="sr">/sjl/</span><span class="n">django</span><span class="o">-</span><span class="n">hoptoad</span><span class="o">/</span>
</pre></div>


<p>There's a git mirror too if you <em>really</em> want it.</p>
<div class="codehilite"><pre><span class="n">git</span> <span class="n">clone</span> <span class="n">git:</span><span class="sr">//gi</span><span class="n">thub</span><span class="o">.</span><span class="n">com</span><span class="sr">/sjl/</span><span class="n">django</span><span class="o">-</span><span class="n">hoptoad</span><span class="o">.</span><span class="n">git</span>
</pre></div>


<p>Once you download it, you can install it in the usual manner:</p>
<div class="codehilite"><pre><span class="n">cd</span> <span class="n">django</span><span class="o">-</span><span class="n">hoptoad</span>
<span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>


<p>If you'd prefer to be able to update at any time by pulling down changes with Mercurial or git, you can symlink the module into your <code>site-packages</code> directory instead of using <code>python setup.py install</code>:</p>
<div class="codehilite"><pre><span class="n">ln</span> <span class="o">-</span><span class="n">s</span> <span class="sr">/full/</span><span class="n">path</span><span class="sr">/to/</span><span class="n">django</span><span class="o">-</span><span class="n">hoptoad</span><span class="sr">/hoptoad /</span><span class="n">full</span><span class="sr">/path/</span><span class="n">to</span><span class="sr">/site-packages/</span>
</pre></div>


<p>To make sure it works you can run:</p>
<div class="codehilite"><pre><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s">&#39;import hoptoad&#39;</span>
</pre></div>


<p>Take a look at the <a href="../quickstart/">Quick Start</a> guide to learn how to report your Django project's errors to Hoptoad.</p>

    
      <p id="footer">
        
          django-hoptoad —
        
        Powered by <a href="http://bitbucket.org/zacharyvoase/markdoc">Markdoc</a>.
      </p>
    
    </div> <!-- div#content -->
  </body>
</html>