Metadata-Version: 2.1
Name: pdfsyntax
Version: 0.0.2
Summary: Tool to generate a static HTML file that represents the internal structure of a PDF file
Home-page: https://github.com/desgeeko/pdfsyntax
Author: Martin D.
Author-email: desgeeko@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/desgeeko/pdfsyntax/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

PDFSyntax
=========

*A Python tool to generate a static HTML file that represents the internal structure of a PDF file*

At some point the low-level functions developed for this CLI will be exposed as an API for programmatic use.

WORK IN PROGRESS!

## CLI

### Features
The generated HTML looks like the raw PDF file with the following additions:
* Pretty-print dictionary object
* Extract an object contained in an object stream and insert it in the flow like a regular object
* Decompress stream and display a small part of it
* Turn indirect object reference into hyperlink
* Turn offset reference (for example a /Prev entry) into hyperlink
* Put some color on key names (for example /Type)
* Display offset of an object

### Screenshot
![PDFSyntax screenshot](screenshot.png)

### Usage
Generate the HTML file and open it in your browser:

    python3 -m pdfsyntax inspect file.pdf > inspection.html

## API
(TODO)



