github/hansken-extraction-plugin-sdk-documentation
1
0
Fork 0
mirror of https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git synced 2026-02-14 14:09:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
hansken-extraction-plugin-s…/0.9.4/dev/python.html
kean-nfi a0c064f9ed 0.9.4: update rest call documentation, added dateTime logic explanation, added none return type documentation 
* 0.9.4: update rest call documentation,

* Update index.html

* Update index.html
2025-03-03 16:09:55 +01:00

157 lines
8.3 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<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>Python &mdash; Hansken Extraction Plugins for plugin developers 0.9.5 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/wider_pages.css?v=32ad70ab" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=61b282d3"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></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="Python API Changelog" href="python/api_changelog.html" />
<link rel="prev" title="Javadoc" href="java/javadoc.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">
Hansken Extraction Plugins for plugin developers
</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"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">General concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="spec.html">Extraction Plugin specifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="java.html">Java</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="python/api_changelog.html">Python API Changelog</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/prerequisites.html">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/getting_started.html">Getting started</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/packaging.html">Packaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/snippets.html">Python code snippets</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/transformers.html">Using Transformers for on-demand execution</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/testing.html">Advanced use of the Test Framework in Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/hanskenpy.html">Run plugins with Hansken.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/debugging.html">How to debug an Extraction Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="#api-documentation">API Documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="python/api/hansken_extraction_plugin.api.html">hansken_extraction_plugin.api</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contact.html">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changes.html">Changelog</a></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">Hansken Extraction Plugins for plugin developers</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 active">Python</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/dev/python.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="python">
<h1>Python<a class="headerlink" href="#python" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="python/api_changelog.html">Python API Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/prerequisites.html">Prerequisites</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/packaging.html">Packaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/snippets.html">Python code snippets</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/transformers.html">Using Transformers for on-demand execution</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/testing.html">Advanced use of the Test Framework in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/hanskenpy.html">Run plugins with Hansken.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/debugging.html">How to debug an Extraction Plugin</a></li>
</ul>
</div>
<section id="api-documentation">
<h2>API Documentation<a class="headerlink" href="#api-documentation" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="python/api/hansken_extraction_plugin.api.html#module-hansken_extraction_plugin.api" title="hansken_extraction_plugin.api"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api</span></code></a></p></td>
<td><p>This package contains the apis of the different classes used by extraction plugins.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="java/javadoc.html" class="btn btn-neutral float-left" title="Javadoc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="python/api_changelog.html" class="btn btn-neutral float-right" title="Python API Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2020-2025 Netherlands Forensic Institute.</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>
Reference in New Issue View Git Blame Copy Permalink