Archives
/
wikiteam
mirror of https://github.com/WikiTeam/wikiteam
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
PiRSquared17-patch-1
rewrite
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9455f79ac1'
${ noResults }
wikiteam/docs/_build/html/index.html

369 lines
22 KiB
HTML
Raw Normal View History Unescape Escape

docs
8 years ago
<!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>Welcome to WikiTeam’s documentation! &mdash; WikiTeam 0.3 documentation</title>
added Classic theme to docs
8 years ago
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
docs
8 years ago
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3',
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>
added Classic theme to docs
8 years ago
<link rel="top" title="WikiTeam 0.3 documentation" href="#" />
docs
8 years ago
</head>
<body role="document">
added Classic theme to docs
8 years ago
<div class="related" role="navigation" aria-label="related navigation">
<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="nav-item nav-item-0"><a href="#">WikiTeam 0.3 documentation</a> &raquo;</li>
</ul>
</div>
docs
8 years ago
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-wikiteam-s-documentation">
<h1>Welcome to WikiTeam&#8217;s documentation!<a class="headerlink" href="#welcome-to-wikiteam-s-documentation" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
</div>
autodoc dumpgenerator
8 years ago
<span class="target" id="module-dumpgenerator"></span><dl class="function">
<dt id="dumpgenerator.avoidWikimediaProjects">
<code class="descclassname">dumpgenerator.</code><code class="descname">avoidWikimediaProjects</code><span class="sig-paren">(</span><em>config={}</em>, <em>other={}</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.avoidWikimediaProjects" title="Permalink to this definition"></a></dt>
<dd><p>Skip Wikimedia projects and redirect to the dumps website</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.bye">
<code class="descclassname">dumpgenerator.</code><code class="descname">bye</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.bye" title="Permalink to this definition"></a></dt>
<dd><p>Closing message</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.checkAPI">
<code class="descclassname">dumpgenerator.</code><code class="descname">checkAPI</code><span class="sig-paren">(</span><em>api=None</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.checkAPI" title="Permalink to this definition"></a></dt>
<dd><p>Checking API availability</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.checkIndex">
<code class="descclassname">dumpgenerator.</code><code class="descname">checkIndex</code><span class="sig-paren">(</span><em>index=None</em>, <em>cookies=None</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.checkIndex" title="Permalink to this definition"></a></dt>
<dd><p>Checking index.php availability</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.checkXMLIntegrity">
<code class="descclassname">dumpgenerator.</code><code class="descname">checkXMLIntegrity</code><span class="sig-paren">(</span><em>config={}</em>, <em>titles=[]</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.checkXMLIntegrity" title="Permalink to this definition"></a></dt>
<dd><p>Check XML dump integrity, to detect broken XML chunks</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.cleanHTML">
<code class="descclassname">dumpgenerator.</code><code class="descname">cleanHTML</code><span class="sig-paren">(</span><em>raw=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.cleanHTML" title="Permalink to this definition"></a></dt>
<dd><p>Extract only the real wiki content and remove rubbish</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.cleanXML">
<code class="descclassname">dumpgenerator.</code><code class="descname">cleanXML</code><span class="sig-paren">(</span><em>xml=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.cleanXML" title="Permalink to this definition"></a></dt>
<dd><p>Trim redundant info</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.curateImageURL">
<code class="descclassname">dumpgenerator.</code><code class="descname">curateImageURL</code><span class="sig-paren">(</span><em>config={}</em>, <em>url=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.curateImageURL" title="Permalink to this definition"></a></dt>
<dd><p>Returns an absolute URL for an image, adding the domain if missing</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.delay">
<code class="descclassname">dumpgenerator.</code><code class="descname">delay</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.delay" title="Permalink to this definition"></a></dt>
<dd><p>Add a delay if configured for that</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.domain2prefix">
<code class="descclassname">dumpgenerator.</code><code class="descname">domain2prefix</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.domain2prefix" title="Permalink to this definition"></a></dt>
<dd><p>Convert domain name to a valid prefix filename.</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.fixBOM">
<code class="descclassname">dumpgenerator.</code><code class="descname">fixBOM</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.fixBOM" title="Permalink to this definition"></a></dt>
<dd><p>Strip Unicode BOM</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.generateImageDump">
<code class="descclassname">dumpgenerator.</code><code class="descname">generateImageDump</code><span class="sig-paren">(</span><em>config={}</em>, <em>other={}</em>, <em>images=[]</em>, <em>start=''</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.generateImageDump" title="Permalink to this definition"></a></dt>
<dd><p>Save files and descriptions using a file list</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.generateXMLDump">
<code class="descclassname">dumpgenerator.</code><code class="descname">generateXMLDump</code><span class="sig-paren">(</span><em>config={}</em>, <em>titles=[]</em>, <em>start=None</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.generateXMLDump" title="Permalink to this definition"></a></dt>
<dd><p>Generates a XML dump for a list of titles</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getImageNames">
<code class="descclassname">dumpgenerator.</code><code class="descname">getImageNames</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getImageNames" title="Permalink to this definition"></a></dt>
<dd><p>Get list of image names</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getImageNamesAPI">
<code class="descclassname">dumpgenerator.</code><code class="descname">getImageNamesAPI</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getImageNamesAPI" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve file list: filename, url, uploader</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getImageNamesScraper">
<code class="descclassname">dumpgenerator.</code><code class="descname">getImageNamesScraper</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getImageNamesScraper" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve file list: filename, url, uploader</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getJSON">
<code class="descclassname">dumpgenerator.</code><code class="descname">getJSON</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getJSON" title="Permalink to this definition"></a></dt>
<dd><p>Strip Unicode BOM</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getNamespacesAPI">
<code class="descclassname">dumpgenerator.</code><code class="descname">getNamespacesAPI</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getNamespacesAPI" title="Permalink to this definition"></a></dt>
<dd><p>Uses the API to get the list of namespaces names and ids</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getNamespacesScraper">
<code class="descclassname">dumpgenerator.</code><code class="descname">getNamespacesScraper</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getNamespacesScraper" title="Permalink to this definition"></a></dt>
<dd><p>Hackishly gets the list of namespaces names and ids from the dropdown in the HTML of Special:AllPages</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getPageTitles">
<code class="descclassname">dumpgenerator.</code><code class="descname">getPageTitles</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getPageTitles" title="Permalink to this definition"></a></dt>
<dd><p>Get list of page titles</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getPageTitlesAPI">
<code class="descclassname">dumpgenerator.</code><code class="descname">getPageTitlesAPI</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getPageTitlesAPI" title="Permalink to this definition"></a></dt>
<dd><p>Uses the API to get the list of page titles</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getPageTitlesScraper">
<code class="descclassname">dumpgenerator.</code><code class="descname">getPageTitlesScraper</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getPageTitlesScraper" title="Permalink to this definition"></a></dt>
<dd><p>Scrape the list of page titles from Special:Allpages</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getUserAgent">
<code class="descclassname">dumpgenerator.</code><code class="descname">getUserAgent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getUserAgent" title="Permalink to this definition"></a></dt>
<dd><p>Return a cool user-agent to hide Python user-agent</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getWikiEngine">
<code class="descclassname">dumpgenerator.</code><code class="descname">getWikiEngine</code><span class="sig-paren">(</span><em>url=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getWikiEngine" title="Permalink to this definition"></a></dt>
<dd><p>Returns the wiki engine of a URL, if known</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getXMLFileDesc">
<code class="descclassname">dumpgenerator.</code><code class="descname">getXMLFileDesc</code><span class="sig-paren">(</span><em>config={}</em>, <em>title=''</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getXMLFileDesc" title="Permalink to this definition"></a></dt>
<dd><p>Get XML for image description page</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getXMLHeader">
<code class="descclassname">dumpgenerator.</code><code class="descname">getXMLHeader</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getXMLHeader" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve a random page to extract XML headers (namespace info, etc)</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getXMLPage">
<code class="descclassname">dumpgenerator.</code><code class="descname">getXMLPage</code><span class="sig-paren">(</span><em>config={}</em>, <em>title=''</em>, <em>verbose=True</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getXMLPage" title="Permalink to this definition"></a></dt>
<dd><p>Get the full history (or current only) of a page</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.getXMLPageCore">
<code class="descclassname">dumpgenerator.</code><code class="descname">getXMLPageCore</code><span class="sig-paren">(</span><em>headers={}</em>, <em>params={}</em>, <em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.getXMLPageCore" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="dumpgenerator.loadConfig">
<code class="descclassname">dumpgenerator.</code><code class="descname">loadConfig</code><span class="sig-paren">(</span><em>config={}</em>, <em>configfilename=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.loadConfig" title="Permalink to this definition"></a></dt>
<dd><p>Load config file</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.logerror">
<code class="descclassname">dumpgenerator.</code><code class="descname">logerror</code><span class="sig-paren">(</span><em>config={}</em>, <em>text=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.logerror" title="Permalink to this definition"></a></dt>
<dd><p>Log error in file</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.main">
<code class="descclassname">dumpgenerator.</code><code class="descname">main</code><span class="sig-paren">(</span><em>params=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.main" title="Permalink to this definition"></a></dt>
<dd><p>Main function</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.mwGetAPIAndIndex">
<code class="descclassname">dumpgenerator.</code><code class="descname">mwGetAPIAndIndex</code><span class="sig-paren">(</span><em>url=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.mwGetAPIAndIndex" title="Permalink to this definition"></a></dt>
<dd><p>Returns the MediaWiki API and Index.php</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.readTitles">
<code class="descclassname">dumpgenerator.</code><code class="descname">readTitles</code><span class="sig-paren">(</span><em>config={}</em>, <em>start=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.readTitles" title="Permalink to this definition"></a></dt>
<dd><p>Read title list from a file, from the title &#8220;start&#8221;</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.removeIP">
<code class="descclassname">dumpgenerator.</code><code class="descname">removeIP</code><span class="sig-paren">(</span><em>raw=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.removeIP" title="Permalink to this definition"></a></dt>
<dd><p>Remove IP from HTML comments &lt;!&#8211; &#8211;&gt;</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.reverse_readline">
<code class="descclassname">dumpgenerator.</code><code class="descname">reverse_readline</code><span class="sig-paren">(</span><em>filename</em>, <em>buf_size=8192</em>, <em>truncate=False</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.reverse_readline" title="Permalink to this definition"></a></dt>
<dd><p>a generator that returns the lines of a file in reverse order</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.saveConfig">
<code class="descclassname">dumpgenerator.</code><code class="descname">saveConfig</code><span class="sig-paren">(</span><em>config={}</em>, <em>configfilename=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.saveConfig" title="Permalink to this definition"></a></dt>
<dd><p>Save config file</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.saveImageNames">
<code class="descclassname">dumpgenerator.</code><code class="descname">saveImageNames</code><span class="sig-paren">(</span><em>config={}</em>, <em>images=[]</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.saveImageNames" title="Permalink to this definition"></a></dt>
<dd><p>Save image list in a file, including filename, url and uploader</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.saveIndexPHP">
<code class="descclassname">dumpgenerator.</code><code class="descname">saveIndexPHP</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.saveIndexPHP" title="Permalink to this definition"></a></dt>
<dd><p>Save index.php as .html, to preserve license details available at the botom of the page</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.saveLogs">
<code class="descclassname">dumpgenerator.</code><code class="descname">saveLogs</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.saveLogs" title="Permalink to this definition"></a></dt>
<dd><p>Save Special:Log</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.saveSiteInfo">
<code class="descclassname">dumpgenerator.</code><code class="descname">saveSiteInfo</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.saveSiteInfo" title="Permalink to this definition"></a></dt>
<dd><p>Save a file with site info</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.saveSpecialVersion">
<code class="descclassname">dumpgenerator.</code><code class="descname">saveSpecialVersion</code><span class="sig-paren">(</span><em>config={}</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.saveSpecialVersion" title="Permalink to this definition"></a></dt>
<dd><p>Save Special:Version as .html, to preserve extensions details</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.truncateFilename">
<code class="descclassname">dumpgenerator.</code><code class="descname">truncateFilename</code><span class="sig-paren">(</span><em>other={}</em>, <em>filename=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.truncateFilename" title="Permalink to this definition"></a></dt>
<dd><p>Truncate filenames when downloading images with large filenames</p>
</dd></dl>
<dl class="function">
<dt id="dumpgenerator.undoHTMLEntities">
<code class="descclassname">dumpgenerator.</code><code class="descname">undoHTMLEntities</code><span class="sig-paren">(</span><em>text=''</em><span class="sig-paren">)</span><a class="headerlink" href="#dumpgenerator.undoHTMLEntities" title="Permalink to this definition"></a></dt>
<dd><p>Undo some HTML codes</p>
</dd></dl>
docs
8 years ago
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to WikiTeam&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
added Classic theme to docs
8 years ago
docs
8 years ago
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
added Classic theme to docs
8 years ago
<div class="related" role="navigation" aria-label="related navigation">
<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="nav-item nav-item-0"><a href="#">WikiTeam 0.3 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&copy; Copyright 2016, WikiTeam developers.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.5.
docs
8 years ago
</div>
</body>
</html>