bellingcat/cisticola
1
0
Fork 0
mirror of https://github.com/bellingcat/cisticola.git synced 2026-06-11 12:58:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
e3d29bf811bb9514993acd973478427adefdba5c
cisticola/docs/build/html/cisticola.transformer.html
Logan Williams e3d29bf811 Add documentation generation with Sphinx
2022-02-21 17:52:38 +01:00

154 lines
7.7 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>cisticola.transformer package &#8212; Cisticola documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="&lt;no title&gt;" href="readme.html" />
<link rel="prev" title="cisticola.scraper package" href="cisticola.scraper.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" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="cisticola-transformer-package">
<h1>cisticola.transformer package<a class="headerlink" href="#cisticola-transformer-package" title="Permalink to this headline"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-cisticola.transformer.twitter">
<span id="cisticola-transformer-twitter-module"></span><h2>cisticola.transformer.twitter module<a class="headerlink" href="#module-cisticola.transformer.twitter" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cisticola.transformer.twitter.TwitterTransformer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cisticola.transformer.twitter.</span></span><span class="sig-name descname"><span class="pre">TwitterTransformer</span></span><a class="headerlink" href="#cisticola.transformer.twitter.TwitterTransformer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cisticola.transformer.Transformer" title="cisticola.transformer.Transformer"><code class="xref py py-class docutils literal notranslate"><span class="pre">cisticola.transformer.Transformer</span></code></a></p>
<p>A Twitter specific ScraperResult, with a method ETL/transforming</p>
<dl class="py method">
<dt class="sig sig-object py" id="cisticola.transformer.twitter.TwitterTransformer.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cisticola.html#cisticola.base.ScraperResult" title="cisticola.base.ScraperResult"><span class="pre">cisticola.base.ScraperResult</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cisticola.html#cisticola.base.TransformedResult" title="cisticola.base.TransformedResult"><span class="pre">cisticola.base.TransformedResult</span></a></span></span><a class="headerlink" href="#cisticola.transformer.twitter.TwitterTransformer.transform" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-cisticola.transformer">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cisticola.transformer" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cisticola.transformer.Transformer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cisticola.transformer.</span></span><span class="sig-name descname"><span class="pre">Transformer</span></span><a class="headerlink" href="#cisticola.transformer.Transformer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Interface class for transformers</p>
<dl class="py method">
<dt class="sig sig-object py" id="cisticola.transformer.Transformer.can_handle">
<span class="sig-name descname"><span class="pre">can_handle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cisticola.transformer.Transformer.can_handle" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cisticola.transformer.Transformer.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cisticola.html#cisticola.base.TransformedResult" title="cisticola.base.TransformedResult"><span class="pre">cisticola.base.TransformedResult</span></a></span></span><a class="headerlink" href="#cisticola.transformer.Transformer.transform" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Cisticola</a></h1>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">cisticola</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="cisticola.html">cisticola package</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">cisticola</a><ul>
<li><a href="cisticola.html">cisticola package</a><ul>
<li>Previous: <a href="cisticola.scraper.html" title="previous chapter">cisticola.scraper package</a></li>
<li>Next: <a href="readme.html" title="next chapter">&lt;no title&gt;</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, Bellingcat.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/cisticola.transformer.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink