feat: 0.2.0

This update adds support for RunLengthDecode and encryption. It also corrects issues in the PNG predictor functions.

docs/source/conf.py

@@ -6,10 +6,12 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+from pdfnaut import __version__
+
 project = 'pdfnaut'
 copyright = '2024, Angel Carias'
 author = 'Angel Carias'
-release = '0.1.1'
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/index.rst

@@ -18,7 +18,30 @@ Features
 
 - Low level PDF manipulation
 - Encryption (AES/ARC4)
-- Serialization of basic documents
+- Document building/serializations
+
+Install
+-------
+
+``pdfnaut`` can be installed from PyPI:
+
+.. tab-set::
+
+    .. tab-item:: Linux/Mac
+
+      .. code-block:: sh
+
+         python3 -m pip install pdfnaut 
+
+    .. tab-item:: Windows
+
+      .. code-block:: sh
+
+         python -m pip install pdfnaut
+
+.. important:: 
+   While ``pdfnaut`` supports encryption, it does not implement these algorithms. You must either supply your own implementations or preferably install a package like ``pycryptodome``
+   that includes these algorithms.
 
 Examples
 --------
@@ -51,6 +74,7 @@ The next example illustrates how ``pdfnaut`` can currently be used to read an ex
    PDF Tokenizer <reference/parsers/simple>
    PDF Parser <reference/parsers/pdf>
    PDF Serializer <reference/serializer>
+   Standard Security Handler <reference/security_handler>
    Objects <reference/objects>
    Exceptions <reference/exceptions>
    Filters <reference/filters>

docs/source/reference/security_handler.rst

@@ -0,0 +1,6 @@
+Standard Security Handler
+=========================
+
+.. automodule:: pdfnaut.security_handler
+    :undoc-members:
+    :members:

pdfnaut/__init__.py

@@ -8,6 +8,6 @@
 __all__ = ("PdfParser", "PdfSerializer")
 
 __name__ = "pdfnaut"
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 __description__ = "Explore PDFs with ease"
 __license__ = "Apache 2.0"

pyproject.toml

@@ -1,6 +1,5 @@
 [project]
 name = "pdfnaut"
-version = "0.1.1"
 description = "Explore PDFs with ease"
 authors = [
     { name = "Angel Carias" }
@@ -21,6 +20,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11", 
     "Programming Language :: Python :: 3.12"    
 ]
+dynamic = ["version"]
 dependencies = []
 
 [project.urls]
@@ -38,6 +38,9 @@ pythonpath = ["."]
 where = ["."]
 include = ["pdfnaut*"]
 
+[tool.setuptools.dynamic]
+version = { attr = "pdfnaut.__version__" }
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"