-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathida.importers.html
206 lines (178 loc) · 15.2 KB
/
ida.importers.html
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ida.importers package — IDA 0.01 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ida.internet package" href="ida.internet.html" />
<link rel="prev" title="ida.exporters package" href="ida.exporters.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
IDA
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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">ida</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="ida.html">ida package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="ida.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="ida.audiovisual.html">ida.audiovisual package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.casemanager.html">ida.casemanager package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.core.html">ida.core package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.datasets.html">ida.datasets package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.exporters.html">ida.exporters package</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">ida.importers package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.internet.html">ida.internet package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.location.html">ida.location package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.modelling.html">ida.modelling package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.networks.html">ida.networks package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.socmed.html">ida.socmed package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.text.html">ida.text package</a></li>
<li class="toctree-l4"><a class="reference internal" href="ida.visualisation.html">ida.visualisation package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ida.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="ida.html#ida-devtools-module">ida.devtools module</a></li>
<li class="toctree-l3"><a class="reference internal" href="ida.html#module-ida">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">IDA</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">ida</a></li>
<li class="breadcrumb-item"><a href="ida.html">ida package</a></li>
<li class="breadcrumb-item active">ida.importers package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/ida.importers.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="ida-importers-package">
<h1>ida.importers package<a class="headerlink" href="#ida-importers-package" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-ida.importers.pdf">
<span id="ida-importers-pdf-module"></span><h2>ida.importers.pdf module<a class="headerlink" href="#module-ida.importers.pdf" title="Permalink to this heading"></a></h2>
<p>Functions to load and parse PDFs</p>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.parse_pdf_authors">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">parse_pdf_authors</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#parse_pdf_authors"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.parse_pdf_authors" title="Permalink to this definition"></a></dt>
<dd><p>Identifies author details from PDF reader result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.parse_pdf_date">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">parse_pdf_date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pdf_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#parse_pdf_date"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.parse_pdf_date" title="Permalink to this definition"></a></dt>
<dd><p>Parses date from PDF reader result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.parse_pdf_links">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">parse_pdf_links</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#parse_pdf_links"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.parse_pdf_links" title="Permalink to this definition"></a></dt>
<dd><p>Parses links from PDF reader result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.parse_pdf_reader_dict">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">parse_pdf_reader_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pdf_dict</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#parse_pdf_reader_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.parse_pdf_reader_dict" title="Permalink to this definition"></a></dt>
<dd><p>Parses PDF reader result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.parse_pdf_text">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">parse_pdf_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#parse_pdf_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.parse_pdf_text" title="Permalink to this definition"></a></dt>
<dd><p>Parses text from PDF reader result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.parse_pdf_title">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">parse_pdf_title</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#parse_pdf_title"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.parse_pdf_title" title="Permalink to this definition"></a></dt>
<dd><p>Parses title from PDF reader result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.pdf_to_dict">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">pdf_to_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#pdf_to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.pdf_to_dict" title="Permalink to this definition"></a></dt>
<dd><p>Reads PDF from file and outputs data as a dictionary.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.pdf_url_to_dict">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">pdf_url_to_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#pdf_url_to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.pdf_url_to_dict" title="Permalink to this definition"></a></dt>
<dd><p>Reads PDF from URL and outputs data as a dictionary.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.read_pdf">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">read_pdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="_modules/ida/importers/pdf.html#read_pdf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.read_pdf" title="Permalink to this definition"></a></dt>
<dd><p>Loads and parses PDF file. Returns a dictionary of data.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ida.importers.pdf.read_pdf_url">
<span class="sig-prename descclassname"><span class="pre">ida.importers.pdf.</span></span><span class="sig-name descname"><span class="pre">read_pdf_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ida/importers/pdf.html#read_pdf_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ida.importers.pdf.read_pdf_url" title="Permalink to this definition"></a></dt>
<dd><p>Downloads and parses PDF file from a URL. Returns a dictionary of data.</p>
</dd></dl>
</section>
<section id="module-ida.importers">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-ida.importers" title="Permalink to this heading"></a></h2>
<p>Functions for importing data from files.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="ida.exporters.html" class="btn btn-neutral float-left" title="ida.exporters package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="ida.internet.html" class="btn btn-neutral float-right" title="ida.internet package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Jamie Hancock.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>