1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Front Matter — SQLSoup 0.9.0 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="SQLSoup 0.9.0 documentation" href="index.html" />
<link rel="next" title="Tutorial" href="tutorial.html" />
<link rel="prev" title="Welcome to SQLSoup’s documentation!" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to SQLSoup’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">SQLSoup 0.9.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="front-matter">
<h1>Front Matter<a class="headerlink" href="#front-matter" title="Permalink to this headline">¶</a></h1>
<p>Information about the SQLSoup project.</p>
<div class="section" id="project-homepage">
<h2>Project Homepage<a class="headerlink" href="#project-homepage" title="Permalink to this headline">¶</a></h2>
<p>SQLSoup is hosted on <a class="reference external" href="http://bitbucket.org">Bitbucket</a> - the lead project
page is at <a class="reference external" href="https://bitbucket.org/zzzeek/sqlsoup">https://bitbucket.org/zzzeek/sqlsoup</a>. Source code is tracked here
using <a class="reference external" href="http://mercurial.selenic.com/">Mercurial</a>.</p>
<p>Releases and project status are available on Pypi at
<a class="reference external" href="http://pypi.python.org/pypi/sqlsoup">http://pypi.python.org/pypi/sqlsoup</a>.</p>
<p>The most recent published version of this documentation should be at
<a class="reference external" href="http://readthedocs.org/docs/sqlsoup/">http://readthedocs.org/docs/sqlsoup/</a>.</p>
</div>
<div class="section" id="project-status">
<h2>Project Status<a class="headerlink" href="#project-status" title="Permalink to this headline">¶</a></h2>
<p>SQLSoup has been included with the SQLAlchemy distribution for many years.
As of 2012 it has been broken out into it’s own project, where it can
be tracked and released separately. The community is also invited to
collaborate on Bitbucket, create forks, and improve the product.</p>
</div>
<div class="section" id="installation">
<span id="id1"></span><h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>Install released versions of SQLSoup from the Python package
index with <a class="reference external" href="http://pypi.python.org/pypi/pip">pip</a> or a similar tool:</p>
<div class="highlight-python"><pre>pip install sqlsoup</pre>
</div>
<p>Installation via source distribution is via the <tt class="docutils literal"><span class="pre">setup.py</span></tt> script:</p>
<div class="highlight-python"><pre>python setup.py install</pre>
</div>
<div class="section" id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
<p>SQLSoup’s install process will ensure that <a class="reference external" href="http://www.sqlalchemy.org">SQLAlchemy</a>
is installed, in addition to other dependencies. The 0.7 series of
SQLAlchemy or greater is recommended.</p>
</div>
</div>
<div class="section" id="community">
<h2>Community<a class="headerlink" href="#community" title="Permalink to this headline">¶</a></h2>
<p>SQLSoup was originally written by Jonathan Ellis. It is under maintenance
by <a class="reference external" href="http://techspot.zzzeek.org">Mike Bayer</a>, and is
loosely associated with the <a class="reference external" href="http://www.sqlalchemy.org">SQLAlchemy</a> project.</p>
</div>
<div class="section" id="bugs">
<span id="id2"></span><h2>Bugs<a class="headerlink" href="#bugs" title="Permalink to this headline">¶</a></h2>
<p>Bugs and feature enhancements to SQLSoup should be reported on the <a class="reference external" href="https://bitbucket.org/zzzeek/sqlsoup/issues?status=new&status=open">Bitbucket
issue tracker</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Front Matter</a><ul>
<li><a class="reference internal" href="#project-homepage">Project Homepage</a></li>
<li><a class="reference internal" href="#project-status">Project Status</a></li>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
</ul>
</li>
<li><a class="reference internal" href="#community">Community</a></li>
<li><a class="reference internal" href="#bugs">Bugs</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to SQLSoup’s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="tutorial.html"
title="next chapter">Tutorial</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/front.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to SQLSoup’s documentation!"
>previous</a> |</li>
<li><a href="index.html">SQLSoup 0.9.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2005-2012, Jonathan Ellis, Mike Bayer.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</div>
</body>
</html>
|
