pdf-auto-outline 0.1.0__tar.gz → 0.1.1__tar.gz

pdf_auto_outline-0.1.1/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.3
+Name: pdf-auto-outline
+Version: 0.1.1
+Summary: Automatically generate and edit PDF table of contents / outline
+Author: Rossikos
+Author-email: Rossikos <216631970+rossikos@users.noreply.github.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Requires-Dist: pymupdf-layout>=1.26.6
+Requires-Dist: sioyek ; extra == 'sioyek'
+Requires-Python: >=3.13
+Project-URL: Bug Tracker, https://github.com/rossikos/pdf-auto-outline/issues
+Project-URL: Homepage, https://github.com/rossikos/pdf-auto-outline
+Provides-Extra: sioyek
+Description-Content-Type: text/markdown
+
+# PDF Auto Outline
+
+Automatically generate and embed a table of contents or outline in a PDF.
+
+Install: `python -m pip install pdf-auto-outline`
+
+Suggestions and contributions are welcome.
+
+## Usage
+
+```
+usage: pdfao [-h] [-s] [-o <path>] [-mp <n>] [-e] [-se] [-i <file>] [-t <n>] [--sioyek <path>] [--version] filename
+
+positional arguments:
+  filename              input pdf
+
+options:
+  -h, --help            show this help message and exit
+  -s, --straight        write toc straight to pdf; skip editing
+  -o, --out <path>      write changes to new pdf
+  -mp, --multiprocess <n>
+                        spread job over n processes (faster on Linux)
+  -e, --edit            edit pdf toc
+  -se, --superedit      edit pdf toc (more attibutes available)
+  -i, --infile <file>   write toc from file to pdf
+  -t, --tablevel <n>    tab = n toc nesting levels (default 2)
+  --sioyek <path>       for users of the Sioyek pdf viewer
+  --version             show program's version number and exit
+```
+
+# Examples
+
+Generate toc and edit before saving:
+`pdfao paper.pdf`
+
+Generate and save to new pdf:
+`pdfao paper.pdf -o new.pdf`
+
+Edit exiting pdf toc:
+`pdfao paper.pdf -e`
+
+A save toc to new pdf from file:
+`pdfao paper.pdf -o new.pdf -i outline.txt`
+
+
+## For Sioyek Users
+
+Example commands; add to `prefs_user.config`.
+
+```
+new_command _gen_toc pdfao "%{file_path}" --sioyek path/to/sioyek -mp 4
+new_command _edit_toc pdfao path/to/pdfao.py "%{file_path}" --sioyek path/to/sioyek -se
+```
+
+If you don't wish to install from PyPI, download source and use `python3 -m path/to/src/pdf_auto_outline` in place of `pdfao`.
+

pdf_auto_outline-0.1.1/README.md

@@ -0,0 +1,56 @@
+# PDF Auto Outline
+
+Automatically generate and embed a table of contents or outline in a PDF.
+
+Install: `python -m pip install pdf-auto-outline`
+
+Suggestions and contributions are welcome.
+
+## Usage
+
+```
+usage: pdfao [-h] [-s] [-o <path>] [-mp <n>] [-e] [-se] [-i <file>] [-t <n>] [--sioyek <path>] [--version] filename
+
+positional arguments:
+  filename              input pdf
+
+options:
+  -h, --help            show this help message and exit
+  -s, --straight        write toc straight to pdf; skip editing
+  -o, --out <path>      write changes to new pdf
+  -mp, --multiprocess <n>
+                        spread job over n processes (faster on Linux)
+  -e, --edit            edit pdf toc
+  -se, --superedit      edit pdf toc (more attibutes available)
+  -i, --infile <file>   write toc from file to pdf
+  -t, --tablevel <n>    tab = n toc nesting levels (default 2)
+  --sioyek <path>       for users of the Sioyek pdf viewer
+  --version             show program's version number and exit
+```
+
+# Examples
+
+Generate toc and edit before saving:
+`pdfao paper.pdf`
+
+Generate and save to new pdf:
+`pdfao paper.pdf -o new.pdf`
+
+Edit exiting pdf toc:
+`pdfao paper.pdf -e`
+
+A save toc to new pdf from file:
+`pdfao paper.pdf -o new.pdf -i outline.txt`
+
+
+## For Sioyek Users
+
+Example commands; add to `prefs_user.config`.
+
+```
+new_command _gen_toc pdfao "%{file_path}" --sioyek path/to/sioyek -mp 4
+new_command _edit_toc pdfao path/to/pdfao.py "%{file_path}" --sioyek path/to/sioyek -se
+```
+
+If you don't wish to install from PyPI, download source and use `python3 -m path/to/src/pdf_auto_outline` in place of `pdfao`.
+

{pdf_auto_outline-0.1.0 → pdf_auto_outline-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pdf-auto-outline"
-version = "0.1.0"
+version = "0.1.1"
 description = "Automatically generate and edit PDF table of contents / outline"
 readme = "README.md"
 authors = [
@@ -11,6 +11,15 @@ dependencies = [
     "pymupdf-layout>=1.26.6",
 ]
 
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+]
+
+[project.optional-dependencies]
+sioyek = ["sioyek"]
+
 [project.scripts]
 pdfao = "pdf_auto_outline.main:main"
 pdf-auto-outline = "pdf_auto_outline.main:main"
@@ -18,3 +27,8 @@ pdf-auto-outline = "pdf_auto_outline.main:main"
 [build-system]
 requires = ["uv_build>=0.9.7,<0.10.0"]
 build-backend = "uv_build"
+
+[project.urls]
+"Homepage" = "https://github.com/rossikos/pdf-auto-outline"
+"Bug Tracker" = "https://github.com/rossikos/pdf-auto-outline/issues"
+

pdf_auto_outline-0.1.1/src/pdf_auto_outline/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.1'

{pdf_auto_outline-0.1.0 → pdf_auto_outline-0.1.1}/src/pdf_auto_outline/main.py

@@ -96,7 +96,6 @@ def generate_toc_nnet(pdfpath, worker_cnt=3) -> list:
         log('\nCancelled')
         exit()
 
-    log('')
 
     return [j for i in pg_nums for j in results[i]]
 
@@ -214,7 +213,6 @@ def parse_txtfile(txtfile='outline.txt', tablevel=2) -> list:
     return toc_entries
 
 def embed_toc(pdfpath, toc_entries, newfile=''):
-    print(len(toc_entries))
     doc = pymupdf.open(pdfpath)
     doc.set_toc(toc_entries, collapse=2)
     if newfile:
@@ -241,14 +239,19 @@ def main():
     parser.add_argument('-i', '--infile', type=str, metavar='<file>', help='write toc from file to pdf')
     parser.add_argument('-t', '--tablevel', type=int, metavar='<n>', help='tab = n toc nesting levels (default 2)', default=2)
     parser.add_argument('--sioyek', type=str, metavar='<path>', help='for users of the Sioyek pdf viewer')
-    parser.add_argument('--version', action='version', version='%(prog)s 0.1.0')
+    parser.add_argument('--version', action='version', version='%(prog)s 0.1.1')
 
     args = parser.parse_args()
 
     if args.sioyek:
         from sioyek.sioyek import Sioyek
-        sioyek_path = args.sioyek[0]
-        SIOYEK = Sioyek(sioyek_path)
+        global SIOYEK
+        SIOYEK = Sioyek(args.sioyek)
+        if args.out:
+            args.out = os.path.join(
+                    os.path.dirname(args.filename),
+                    args.out
+                )
         # local_db = args.sioyek[1]
         # shared_db = args.sioyek[2]
         # pdf_path = args.sioyek[3]
@@ -267,6 +270,7 @@ def main():
         start = perf_counter()
         toc_entries = generate_toc_nnet(args.filename, args.multiprocess)
         end = perf_counter()
+        log('')
         log(f"finished in {end - start:<4.1f} s")
         toc_entries = align_toc_lvls(toc_entries)
         if args.straight:

pdf_auto_outline-0.1.0/PKG-INFO

@@ -1,46 +0,0 @@
-Metadata-Version: 2.3
-Name: pdf-auto-outline
-Version: 0.1.0
-Summary: Automatically generate and edit PDF table of contents / outline
-Author: Rossikos
-Author-email: Rossikos <216631970+rossikos@users.noreply.github.com>
-Requires-Dist: pymupdf-layout>=1.26.6
-Requires-Python: >=3.13
-Description-Content-Type: text/markdown
-
-# PDF Auto Outline
-
-A simple python program to automatically generate and embed a table of contents or outline in a PDF.
-
-## Usage
-
-```
-usage: pdfao [-h] [-s] [-o <path>] [-mp <n>] [-e] [-se] [-i <file>] [-t <n>] [--sioyek <path>] [--version] filename
-
-positional arguments:
-  filename              input pdf
-
-options:
-  -h, --help            show this help message and exit
-  -s, --straight        write toc straight to pdf; skip editing
-  -o, --out <path>      write changes to new pdf
-  -mp, --multiprocess <n>
-                        spread job over n processes (faster on linux)
-  -e, --edit            edit pdf toc
-  -se, --superedit      edit pdf toc (more attibutes available)
-  -i, --infile <file>   write toc from file to pdf
-  -t, --tablevel <n>    tab = n toc nesting levels (default 2)
-  --sioyek <path>       for users of the Sioyek pdf viewer
-  --version             show program's version number and exit
-```
-
-## For Sioyek Users
-
-Example commands; add to prefs_user.config.
-
-```
-new_command _gen_toc python3 path/to/pdfao.py "%{file_path}" --sioyek path/to/sioyek -mp 4
-new_command _edit_toc python3 path/to/pdfao.py "%{file_path}" --sioyek path/to/sioyek -e
-```
-
-

pdf_auto_outline-0.1.0/README.md

@@ -1,36 +0,0 @@
-# PDF Auto Outline
-
-A simple python program to automatically generate and embed a table of contents or outline in a PDF.
-
-## Usage
-
-```
-usage: pdfao [-h] [-s] [-o <path>] [-mp <n>] [-e] [-se] [-i <file>] [-t <n>] [--sioyek <path>] [--version] filename
-
-positional arguments:
-  filename              input pdf
-
-options:
-  -h, --help            show this help message and exit
-  -s, --straight        write toc straight to pdf; skip editing
-  -o, --out <path>      write changes to new pdf
-  -mp, --multiprocess <n>
-                        spread job over n processes (faster on linux)
-  -e, --edit            edit pdf toc
-  -se, --superedit      edit pdf toc (more attibutes available)
-  -i, --infile <file>   write toc from file to pdf
-  -t, --tablevel <n>    tab = n toc nesting levels (default 2)
-  --sioyek <path>       for users of the Sioyek pdf viewer
-  --version             show program's version number and exit
-```
-
-## For Sioyek Users
-
-Example commands; add to prefs_user.config.
-
-```
-new_command _gen_toc python3 path/to/pdfao.py "%{file_path}" --sioyek path/to/sioyek -mp 4
-new_command _edit_toc python3 path/to/pdfao.py "%{file_path}" --sioyek path/to/sioyek -e
-```
-
-

pdf_auto_outline-0.1.0/src/pdf_auto_outline/__init__.py

@@ -1 +0,0 @@
-__version__ = '0.1.0'