diff --git a/docs/source/conf.py b/docs/source/conf.py index d74f70e..7e95447 100644 --- a/docs/source/conf.py +++ b/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 diff --git a/docs/source/index.rst b/docs/source/index.rst index 683e111..37adb20 100644 --- a/docs/source/index.rst +++ b/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 PDF Parser PDF Serializer + Standard Security Handler Objects Exceptions Filters diff --git a/docs/source/reference/security_handler.rst b/docs/source/reference/security_handler.rst new file mode 100644 index 0000000..fdfb137 --- /dev/null +++ b/docs/source/reference/security_handler.rst @@ -0,0 +1,6 @@ +Standard Security Handler +========================= + +.. automodule:: pdfnaut.security_handler + :undoc-members: + :members: diff --git a/pdfnaut/__init__.py b/pdfnaut/__init__.py index 92e15b8..bb59e19 100644 --- a/pdfnaut/__init__.py +++ b/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" diff --git a/pyproject.toml b/pyproject.toml index 1804c3f..b7cfa71 100644 --- a/pyproject.toml +++ b/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"