245 lines
8.7 KiB
HTML
245 lines
8.7 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="None">
|
|
|
|
<link rel="shortcut icon" href="img/favicon.ico">
|
|
<title>Home - PDF Major</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Home";
|
|
var mkdocs_page_input_path = "index.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<script src="js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href="." class="icon icon-home"> PDF Major</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" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1 current">
|
|
|
|
<a class="current" href=".">Home</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#pdfmajor">PDFMajor</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#documentation">Documentation</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#basic-example">Basic Example</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#why-another-fork">Why Another Fork?</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#features">Features</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#how-to-install">How to Install</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#terms-and-conditions">Terms and Conditions</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="api/">API</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href=".">PDF Major</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Home</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="pdfmajor">PDFMajor</h1>
|
|
<table>
|
|
<tr>
|
|
<td>Latest Release</td>
|
|
<td>
|
|
<a href="https://pypi.org/project/pdfmajor/">
|
|
<img src="https://img.shields.io/pypi/v/pdfmajor.svg" alt="latest release" />
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>PDF-Major is a fork of <code>PDFMiner.six</code>. It is meant to be a more light-weight implementation that makes fewer assumptions on the data. The ultimate goal of this project is to provide a simpler, faster and more functional library that both casual and low-level developers could build upon.</p>
|
|
<h2 id="documentation">Documentation</h2>
|
|
<p>See documentation <a href="https://asosnovsky.github.io/pdfmajor/">here</a>.</p>
|
|
<h2 id="basic-example">Basic Example</h2>
|
|
<pre><code class="py">from pdfmajor.interpreter import PageInterpreter
|
|
|
|
for page in PDFInterpreter("/path/to/pdf.pdf"):
|
|
print("page start", page.page_num)
|
|
for item in page:
|
|
print(" >", item)
|
|
print("page end", page.page_num)
|
|
|
|
</code></pre>
|
|
|
|
<h2 id="why-another-fork">Why Another Fork?</h2>
|
|
<p><code>PDFMiner</code> was designed to run in python 2.7>, <code>PDFMiner.six</code> was written to bring cross-version support for python 2 and 3. However, after attempting to build and extend upon <code>PDFMiner.six</code> I found it rather difficult to extend and identify additional details regarding the items encoded in the pdf. This library will attempt to expose as much information as possible to end-users, without having them solely rely on to-xml or to-json exports.</p>
|
|
<h2 id="features">Features</h2>
|
|
<ul>
|
|
<li>Functional extraction method based on generators</li>
|
|
<li>Parse, analyze, and convert PDF documents.</li>
|
|
<li>PDF-1.7 specification support. (well, almost)</li>
|
|
<li>Font-Color extraction</li>
|
|
<li>Shape fill and stroke color extraction</li>
|
|
<li>CJK languages and vertical writing scripts support.</li>
|
|
<li>Various font types (Type1, TrueType, Type3, and CID) support.</li>
|
|
<li>Basic encryption (RC4) support.</li>
|
|
</ul>
|
|
<p><strong>Note</strong>: We took out the layout-analysis process in this version (there is no more LTTextHorizontal or LTTextVertical). While the mathematics behind the grouping process was sound, the coupling of the layout-analysis process with the parsing and interpretation process produced unfriendly-code. This feature could be brought back by running your own implementation of it on the <code>pdfmajor.interpreter.PageInterpreter</code> class, but at the current time is not supported.</p>
|
|
<h2 id="how-to-install">How to Install</h2>
|
|
<h3 id="source">Source</h3>
|
|
<ul>
|
|
<li>Install Python 3.6.4 or newer.</li>
|
|
<li>
|
|
<p>clone this repo</p>
|
|
<p><code>git clone https://github.com/asosnovsky/pdfmajor</code>
|
|
* install repo</p>
|
|
<p><code>python setup.py install</code></p>
|
|
</li>
|
|
</ul>
|
|
<h3 id="pypi">Pypi</h3>
|
|
<ul>
|
|
<li>Install Python 3.6.4 or newer.</li>
|
|
<li>
|
|
<p>install repo</p>
|
|
<p><code>pip install pdfmajor</code></p>
|
|
</li>
|
|
</ul>
|
|
<h2 id="terms-and-conditions">Terms and Conditions</h2>
|
|
<p>(This is so-called MIT/X License)</p>
|
|
<p>Copyright (c) 2018-2019 Ariel Sosnovsky <ariel at sosnovsky dot ca></p>
|
|
<p>Permission is hereby granted, free of charge, to any person
|
|
obtaining a copy of this software and associated documentation
|
|
files (the "Software"), to deal in the Software without
|
|
restriction, including without limitation the rights to use,
|
|
copy, modify, merge, publish, distribute, sublicense, and/or
|
|
sell copies of the Software, and to permit persons to whom the
|
|
Software is furnished to do so, subject to the following
|
|
conditions:</p>
|
|
<p>The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.</p>
|
|
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
|
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
|
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="api/" class="btn btn-neutral float-right" title="API">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="api/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '.';</script>
|
|
<script src="js/theme.js" defer></script>
|
|
<script src="search/main.js" defer></script>
|
|
|
|
</body>
|
|
</html>
|
|
|
|
<!--
|
|
MkDocs version : 1.0.4
|
|
Build Date UTC : 2018-12-24 06:52:28
|
|
-->
|