mirror of
https://github.com/WikiTeam/wikiteam
synced 2024-11-12 07:12:41 +00:00
autodoc dumpgenerator
This commit is contained in:
emijrp
parent
bf3ff4468b
commit
358ea0248e
BIN
docs/_build/doctrees/environment.pickle
vendored
BIN
docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/_build/doctrees/index.doctree
vendored
BIN
docs/_build/doctrees/index.doctree
vendored
Binary file not shown.
3
docs/_build/html/_sources/index.txt
vendored
3
docs/_build/html/_sources/index.txt
vendored
@ -11,7 +11,8 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
.. automodule:: dumpgenerator
|
||||
:members:
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
274
docs/_build/html/genindex.html
vendored
274
docs/_build/html/genindex.html
vendored
@ -44,8 +44,282 @@
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#A"><strong>A</strong></a>
|
||||
| <a href="#B"><strong>B</strong></a>
|
||||
| <a href="#C"><strong>C</strong></a>
|
||||
| <a href="#D"><strong>D</strong></a>
|
||||
| <a href="#F"><strong>F</strong></a>
|
||||
| <a href="#G"><strong>G</strong></a>
|
||||
| <a href="#L"><strong>L</strong></a>
|
||||
| <a href="#M"><strong>M</strong></a>
|
||||
| <a href="#R"><strong>R</strong></a>
|
||||
| <a href="#S"><strong>S</strong></a>
|
||||
| <a href="#T"><strong>T</strong></a>
|
||||
| <a href="#U"><strong>U</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="A">A</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.avoidWikimediaProjects">avoidWikimediaProjects() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="B">B</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.bye">bye() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="C">C</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.checkAPI">checkAPI() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.checkIndex">checkIndex() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.checkXMLIntegrity">checkXMLIntegrity() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.cleanHTML">cleanHTML() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.cleanXML">cleanXML() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.curateImageURL">curateImageURL() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="D">D</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.delay">delay() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.domain2prefix">domain2prefix() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#module-dumpgenerator">dumpgenerator (module)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="F">F</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.fixBOM">fixBOM() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="G">G</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.generateImageDump">generateImageDump() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.generateXMLDump">generateXMLDump() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getImageNames">getImageNames() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getImageNamesAPI">getImageNamesAPI() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getImageNamesScraper">getImageNamesScraper() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getJSON">getJSON() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getNamespacesAPI">getNamespacesAPI() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getNamespacesScraper">getNamespacesScraper() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getPageTitles">getPageTitles() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getPageTitlesAPI">getPageTitlesAPI() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getPageTitlesScraper">getPageTitlesScraper() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getUserAgent">getUserAgent() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getWikiEngine">getWikiEngine() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getXMLFileDesc">getXMLFileDesc() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getXMLHeader">getXMLHeader() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getXMLPage">getXMLPage() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.getXMLPageCore">getXMLPageCore() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="L">L</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.loadConfig">loadConfig() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.logerror">logerror() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="M">M</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.main">main() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.mwGetAPIAndIndex">mwGetAPIAndIndex() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="R">R</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.readTitles">readTitles() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.removeIP">removeIP() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.reverse_readline">reverse_readline() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="S">S</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.saveConfig">saveConfig() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.saveImageNames">saveImageNames() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.saveIndexPHP">saveIndexPHP() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.saveLogs">saveLogs() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.saveSiteInfo">saveSiteInfo() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.saveSpecialVersion">saveSpecialVersion() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="T">T</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.truncateFilename">truncateFilename() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="U">U</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="index.html#dumpgenerator.undoHTMLEntities">undoHTMLEntities() (in module dumpgenerator)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
257
docs/_build/html/index.html
vendored
257
docs/_build/html/index.html
vendored
@ -44,6 +44,263 @@
|
||||
<p>Contents:</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
<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 “start”</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 <!– –></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>
|
||||
|
||||
</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>
|
||||
|
||||
BIN
docs/_build/html/objects.inv
vendored
BIN
docs/_build/html/objects.inv
vendored
Binary file not shown.
106
docs/_build/html/py-modindex.html
vendored
Normal file
106
docs/_build/html/py-modindex.html
vendored
Normal file
@ -0,0 +1,106 @@
|
||||
<!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>Python Module Index — WikiTeam 0.3 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.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.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>
|
||||
<link rel="top" title="WikiTeam 0.3 documentation" href="index.html" />
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
|
||||
</script>
|
||||
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1>Python Module Index</h1>
|
||||
|
||||
<div class="modindex-jumpbox">
|
||||
<a href="#cap-d"><strong>d</strong></a>
|
||||
</div>
|
||||
|
||||
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-d"><td></td><td>
|
||||
<strong>d</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="index.html#module-dumpgenerator"><code class="xref">dumpgenerator</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></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>
|
||||
<div class="footer">
|
||||
©2016, WikiTeam developers.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
2
docs/_build/html/searchindex.js
vendored
2
docs/_build/html/searchindex.js
vendored
@ -1 +1 @@
|
||||
Search.setIndex({envversion:49,filenames:["index"],objects:{},objnames:{},objtypes:{},terms:{content:0,index:0,modul:0,page:0,search:0},titles:["Welcome to WikiTeam’s documentation!"],titleterms:{document:0,indice:0,tabl:0,welcom:0,wikiteam:0}})
|
||||
Search.setIndex({envversion:49,filenames:["index"],objects:{"":{dumpgenerator:[0,0,0,"-"]},dumpgenerator:{avoidWikimediaProjects:[0,1,1,""],bye:[0,1,1,""],checkAPI:[0,1,1,""],checkIndex:[0,1,1,""],checkXMLIntegrity:[0,1,1,""],cleanHTML:[0,1,1,""],cleanXML:[0,1,1,""],curateImageURL:[0,1,1,""],delay:[0,1,1,""],domain2prefix:[0,1,1,""],fixBOM:[0,1,1,""],generateImageDump:[0,1,1,""],generateXMLDump:[0,1,1,""],getImageNames:[0,1,1,""],getImageNamesAPI:[0,1,1,""],getImageNamesScraper:[0,1,1,""],getJSON:[0,1,1,""],getNamespacesAPI:[0,1,1,""],getNamespacesScraper:[0,1,1,""],getPageTitles:[0,1,1,""],getPageTitlesAPI:[0,1,1,""],getPageTitlesScraper:[0,1,1,""],getUserAgent:[0,1,1,""],getWikiEngine:[0,1,1,""],getXMLFileDesc:[0,1,1,""],getXMLHeader:[0,1,1,""],getXMLPage:[0,1,1,""],getXMLPageCore:[0,1,1,""],loadConfig:[0,1,1,""],logerror:[0,1,1,""],main:[0,1,1,""],mwGetAPIAndIndex:[0,1,1,""],readTitles:[0,1,1,""],removeIP:[0,1,1,""],reverse_readline:[0,1,1,""],saveConfig:[0,1,1,""],saveImageNames:[0,1,1,""],saveIndexPHP:[0,1,1,""],saveLogs:[0,1,1,""],saveSiteInfo:[0,1,1,""],saveSpecialVersion:[0,1,1,""],truncateFilename:[0,1,1,""],undoHTMLEntities:[0,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"function":0,"return":0,"true":0,absolut:0,add:0,agent:0,allpage:0,api:0,avail:0,avoidwikimediaproject:0,bom:0,botom:0,broken:0,buf_siz:0,bye:0,check:0,checkapi:0,checkindex:0,checkxmlintegr:0,chunk:0,cleanhtml:0,cleanxml:0,close:0,code:0,comment:0,config:0,configfilenam:0,configur:0,content:0,convert:0,cooki:0,cool:0,curateimageurl:0,current:0,delai:0,descript:0,detail:0,detect:0,domain2prefix:0,domain:0,download:0,dropdown:0,dump:0,dumpgener:0,engin:0,error:0,etc:0,extens:0,extract:0,fals:0,file:0,filenam:0,fixbom:0,from:0,full:0,gener:0,generateimagedump:0,generatexmldump:0,get:0,getimagenam:0,getimagenamesapi:0,getimagenamesscrap:0,getjson:0,getnamespacesapi:0,getnamespacesscrap:0,getpagetitl:0,getpagetitlesapi:0,getpagetitlesscrap:0,getuserag:0,getwikiengin:0,getxmlfiledesc:0,getxmlhead:0,getxmlpag:0,getxmlpagecor:0,hackishli:0,header:0,hide:0,histori:0,html:0,imag:0,includ:0,index:0,info:0,integr:0,known:0,larg:0,licens:0,line:0,list:0,load:0,loadconfig:0,log:0,logerror:0,main:0,mediawiki:0,messag:0,miss:0,modul:0,mwgetapiandindex:0,name:0,namespac:0,none:0,onli:0,order:0,other:0,page:0,param:0,php:0,prefix:0,preserv:0,project:0,python:0,random:0,raw:0,read:0,readtitl:0,real:0,redirect:0,redund:0,remov:0,removeip:0,request:0,retriev:0,revers:0,reverse_readlin:0,rubbish:0,save:0,saveconfig:0,saveimagenam:0,saveindexphp:0,savelog:0,savesiteinfo:0,savespecialvers:0,scrape:0,search:0,session:0,site:0,skip:0,some:0,special:0,start:0,strip:0,text:0,titl:0,trim:0,truncat:0,truncatefilenam:0,undo:0,undohtmlent:0,unicod:0,upload:0,url:0,use:0,user:0,valid:0,verbos:0,version:0,websit:0,when:0,wiki:0,wikimedia:0,xml:0},titles:["Welcome to WikiTeam’s documentation!"],titleterms:{document:0,indice:0,tabl:0,welcom:0,wikiteam:0}})
|
||||
@ -16,9 +16,10 @@
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
import os
|
||||
import sys
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
|
||||
@ -11,7 +11,8 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
.. automodule:: dumpgenerator
|
||||
:members:
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
Loading…
Reference in New Issue
Block a user