Permalink
Browse files

updated docs

  • Loading branch information...
1 parent 50102d4 commit a46b6ef9bd618597d3c864e68dd428a9bd4af59c @sahib committed Jul 24, 2012
Showing with 103 additions and 55 deletions.
  1. +1 −1 _sources/index.txt
  2. +36 −18 _sources/intro.txt
  3. +4 −3 _sources/provider.txt
  4. +14 −10 examples.html
  5. +14 −10 examples/threads.py
  6. +3 −2 index.html
  7. +26 −7 intro.html
  8. BIN objects.inv
  9. +4 −3 provider.html
  10. +1 −1 searchindex.js
View
@@ -27,7 +27,7 @@ Contents:
.. note::
- The version of this wrapper will follow mirror libglyr's version.
+ The version of this wrapper will mirror libglyr's version.
Indices and tables
==================
View
@@ -19,33 +19,45 @@ Useful links
http://sahib.github.com/glyr/doc/html/index.html
+**plyr on github:**
-Installing
-----------
+ https://github.com/sahib/python-glyr
-.. note::
-
- This Wrapper is beta-software. It may blow your computer totally unexcpted.
+**plyr on PyPI:**
-Install libglyr if not done yet. Either..
+ http://pypi.python.org/pypi/plyr
+
+Installing
+----------
-- ... compile from Source: https://github.com/sahib/glyr/wiki/Compiling
-- ... or use the package your distribution provides.
-- ... in doubt, compile yourself.
+**Using PyPI:**
-
-Install *cython* if not done yet: ::
+ Use *pip* to install the package from source: ::
- sudo pip install cython
+ sudo pip install plyr
-Build & install the Wrapper: ::
- git clone git://github.com/sahib/python-glyr.git
- cd python-glyr
- sudo python setup.py install
+**Manual Installation (most recent):**
-Documentation
--------------
+ Install libglyr if not done yet. Either..
+
+ - ... compile from Source: https://github.com/sahib/glyr/wiki/Compiling
+ - ... or use the package your distribution provides.
+ - ... in doubt, compile yourself. I only test the latest version.
+
+
+ Install *cython* if not done yet: ::
+
+ sudo pip install cython
+
+ Build & install the Wrapper: ::
+
+ git clone git://github.com/sahib/python-glyr.git
+ cd python-glyr
+ sudo python setup.py install
+
+Documentation?
+--------------
Silly question. You're looking at it.
But when we're on it: There are only a few chapters, since there
@@ -66,3 +78,9 @@ You can set it via: ::
Why? In case your application makes strange things and causes heavy traffic on
the provider's sites, they may ban the user-agent that makes this requests.
So, only your project gets (temporarly) banned, and not all libglyr itself.
+
+TODOs:
+------
+
+- Finish libglyr; clean up API -> may break this here. (*sigh*!)
+- Make a Provider Test-table, and replace the old ruby tests with that. (There be dragons).
View
@@ -6,8 +6,8 @@ Looking up Providers
.. code-block:: python
'albumlist': {
- 'optional' : ('album', 'title'),
- 'required' : ('artist'),
+ 'optional' : ('album'),
+ 'required' : (),
'provider' : [{
'key' : 'm',
'name' : 'musicbrainz',
@@ -30,4 +30,5 @@ You get the idea. Use ``itertools`` and friends to get the data you want in a on
.. note::
- This dictionary gets built on import.
+ This dictionary gets built on import. Different version of libglyr may
+ deliver different providers.
View
@@ -123,16 +123,20 @@
<span class="sd">Example on how to use the cancel() function of the Query.</span>
<span class="sd">If a Query has been started it wil block the calling thread.</span>
-<span class="sd">This may be bad, when you want to do something different in the meantime.</span>
-<span class="sd">You can safely run qry.commit() in a seperate thread and do some data-sharing.</span>
-<span class="sd">But sometimes (e.g. on application exit) you may want to stop all running queries.</span>
-<span class="sd">This can be done via the cancel() function - it will stop all running downloads</span>
-<span class="sd">associated with this query.</span>
-
-<span class="sd">There is no cancel_all() function. You gonna need a pool with all Queries you&#39;re running.</span>
-
-<span class="sd">Note: cancel() will not stop __imediately__, since some provider may do some</span>
-<span class="sd"> stuff that is hard to interrupt, but at least you do not need to care about cleanup.</span>
+<span class="sd">This may be bad, when you want to do something</span>
+<span class="sd">different in the meantime. You can safely run qry.commit()</span>
+<span class="sd">in a seperate thread and do some data-sharing. But sometimes</span>
+<span class="sd">(e.g. on application exit) you may want to stop all running queries.</span>
+<span class="sd">This can be done via the cancel() function - it will stop</span>
+<span class="sd">all running downloads associated with this query.</span>
+
+<span class="sd">There is no cancel_all() function.</span>
+<span class="sd">You gonna need a pool with all Queries you&#39;re running.</span>
+
+<span class="sd">Note: cancel() will not stop __imediately__,</span>
+<span class="sd"> since some provider may do some</span>
+<span class="sd"> stuff that is hard to interrupt,</span>
+<span class="sd"> but at least you do not need to care about cleanup.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;__main__&#39;</span><span class="p">:</span>
View
@@ -10,16 +10,20 @@
Example on how to use the cancel() function of the Query.
If a Query has been started it wil block the calling thread.
-This may be bad, when you want to do something different in the meantime.
-You can safely run qry.commit() in a seperate thread and do some data-sharing.
-But sometimes (e.g. on application exit) you may want to stop all running queries.
-This can be done via the cancel() function - it will stop all running downloads
-associated with this query.
-
-There is no cancel_all() function. You gonna need a pool with all Queries you're running.
-
-Note: cancel() will not stop __imediately__, since some provider may do some
- stuff that is hard to interrupt, but at least you do not need to care about cleanup.
+This may be bad, when you want to do something
+different in the meantime. You can safely run qry.commit()
+in a seperate thread and do some data-sharing. But sometimes
+(e.g. on application exit) you may want to stop all running queries.
+This can be done via the cancel() function - it will stop
+all running downloads associated with this query.
+
+There is no cancel_all() function.
+You gonna need a pool with all Queries you're running.
+
+Note: cancel() will not stop __imediately__,
+ since some provider may do some
+ stuff that is hard to interrupt,
+ but at least you do not need to care about cleanup.
"""
if __name__ == '__main__':
View
@@ -66,8 +66,9 @@
<li class="toctree-l2"><a class="reference internal" href="intro.html#what-is-this-about">What is this about?</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#useful-links">Useful links</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#installing">Installing</a></li>
-<li class="toctree-l2"><a class="reference internal" href="intro.html#documentation">Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="intro.html#documentation">Documentation?</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#other-things-to-note">Other things to note?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="intro.html#todos">TODOs:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="query.html">Building Queries</a><ul>
@@ -99,7 +100,7 @@
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">The version of this wrapper will follow mirror libglyr&#8217;s version.</p>
+<p class="last">The version of this wrapper will mirror libglyr&#8217;s version.</p>
</div>
</div>
<div class="section" id="indices-and-tables">
View
@@ -72,18 +72,28 @@
<p><strong>libglyr&#8217;s API doc:</strong></p>
<blockquote>
<div><a class="reference external" href="http://sahib.github.com/glyr/doc/html/index.html">http://sahib.github.com/glyr/doc/html/index.html</a></div></blockquote>
+<p><strong>plyr on github:</strong></p>
+<blockquote>
+<div><a class="reference external" href="https://github.com/sahib/python-glyr">https://github.com/sahib/python-glyr</a></div></blockquote>
+<p><strong>plyr on PyPI:</strong></p>
+<blockquote>
+<div><a class="reference external" href="http://pypi.python.org/pypi/plyr">http://pypi.python.org/pypi/plyr</a></div></blockquote>
</div>
<div class="section" id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h2>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">This Wrapper is beta-software. It may blow your computer totally unexcpted.</p>
+<p><strong>Using PyPI:</strong></p>
+<blockquote>
+<div><p>Use <em>pip</em> to install the package from source:</p>
+<div class="highlight-python"><pre>sudo pip install plyr</pre>
</div>
-<p>Install libglyr if not done yet. Either..</p>
+</div></blockquote>
+<p><strong>Manual Installation (most recent):</strong></p>
+<blockquote>
+<div><p>Install libglyr if not done yet. Either..</p>
<ul class="simple">
<li>... compile from Source: <a class="reference external" href="https://github.com/sahib/glyr/wiki/Compiling">https://github.com/sahib/glyr/wiki/Compiling</a></li>
<li>... or use the package your distribution provides.</li>
-<li>... in doubt, compile yourself.</li>
+<li>... in doubt, compile yourself. I only test the latest version.</li>
</ul>
<p>Install <em>cython</em> if not done yet:</p>
<div class="highlight-python"><pre>sudo pip install cython</pre>
@@ -93,9 +103,10 @@
cd python-glyr
sudo python setup.py install</pre>
</div>
+</div></blockquote>
</div>
<div class="section" id="documentation">
-<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
+<h2>Documentation?<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<p>Silly question. You&#8217;re looking at it.
But when we&#8217;re on it: There are only a few chapters, since there
is not so much to cover. Every chapter is split into a description,
@@ -114,6 +125,13 @@
the provider&#8217;s sites, they may ban the user-agent that makes this requests.
So, only your project gets (temporarly) banned, and not all libglyr itself.</p>
</div>
+<div class="section" id="todos">
+<h2>TODOs:<a class="headerlink" href="#todos" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li>Finish libglyr; clean up API -&gt; may break this here. (<em>sigh</em>!)</li>
+<li>Make a Provider Test-table, and replace the old ruby tests with that. (There be dragons).</li>
+</ul>
+</div>
</div>
@@ -128,8 +146,9 @@
<li><a class="reference internal" href="#what-is-this-about">What is this about?</a></li>
<li><a class="reference internal" href="#useful-links">Useful links</a></li>
<li><a class="reference internal" href="#installing">Installing</a></li>
-<li><a class="reference internal" href="#documentation">Documentation</a></li>
+<li><a class="reference internal" href="#documentation">Documentation?</a></li>
<li><a class="reference internal" href="#other-things-to-note">Other things to note?</a></li>
+<li><a class="reference internal" href="#todos">TODOs:</a></li>
</ul>
</li>
</ul>
View
Binary file not shown.
View
@@ -60,8 +60,8 @@
<h1>Looking up Providers<a class="headerlink" href="#looking-up-providers" title="Permalink to this headline">¶</a></h1>
<p><tt class="docutils literal"><span class="pre">plyr.PROVIDERS</span></tt> contains a nested dict modelling all compiled in fetchers and providers.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="s">&#39;albumlist&#39;</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">&#39;optional&#39;</span> <span class="p">:</span> <span class="p">(</span><span class="s">&#39;album&#39;</span><span class="p">,</span> <span class="s">&#39;title&#39;</span><span class="p">),</span>
- <span class="s">&#39;required&#39;</span> <span class="p">:</span> <span class="p">(</span><span class="s">&#39;artist&#39;</span><span class="p">),</span>
+ <span class="s">&#39;optional&#39;</span> <span class="p">:</span> <span class="p">(</span><span class="s">&#39;album&#39;</span><span class="p">),</span>
+ <span class="s">&#39;required&#39;</span> <span class="p">:</span> <span class="p">(),</span>
<span class="s">&#39;provider&#39;</span> <span class="p">:</span> <span class="p">[{</span>
<span class="s">&#39;key&#39;</span> <span class="p">:</span> <span class="s">&#39;m&#39;</span><span class="p">,</span>
<span class="s">&#39;name&#39;</span> <span class="p">:</span> <span class="s">&#39;musicbrainz&#39;</span><span class="p">,</span>
@@ -84,7 +84,8 @@
<p>You get the idea. Use <tt class="docutils literal"><span class="pre">itertools</span></tt> and friends to get the data you want in a oneliner.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">This dictionary gets built on import.</p>
+<p class="last">This dictionary gets built on import. Different version of libglyr may
+deliver different providers.</p>
</div>
</div>
Oops, something went wrong.

0 comments on commit a46b6ef

Please sign in to comment.