pdf-auto-outline 0.1.4__tar.gz → 0.1.5__tar.gz

{pdf_auto_outline-0.1.4 → pdf_auto_outline-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pdf-auto-outline
-Version: 0.1.4
+Version: 0.1.5
 Summary: Automatically generate and edit PDF table of contents / outline
 Author: Rossikos
 Author-email: Rossikos <216631970+rossikos@users.noreply.github.com>
@@ -62,6 +62,29 @@ Edit exiting pdf toc:
 A save toc to new pdf from file:
 `pdfao paper.pdf -o new.pdf -i outline.txt`
 
+### Editing
+
+The edit command opens the TOC in the OS default editor (result of 'start' command on Windows and 'EDITOR' environment variable on MacOS and Linux). The file schema is something like this:
+
+```
+Title 1  |  1
+    Title 2  |  2  |  *
+                 ^^^^^^
+				 optional		
+```
+The essential parts of each line are:
+- Indentation - 4 space characters per nesting level (or use tabs with the -t flag).
+- Title text
+- Delimiter - '  |  ' (vertical bar with 2 spaces padding on each side)
+- Page number
+
+The optional part can be one of:
+```
+  |  None                  	same as not including it   
+  |  241.2					y-ordinate 
+  |  Point(72.0, 363.9)		x and y coords
+  |  {<dictionary>}			dictionary with more attributes for the ToC entry
+```
 
 ## For Sioyek Users
 
@@ -69,7 +92,7 @@ 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 %{file_path}" --sioyek path/to/sioyek -e
+new_command _edit_toc pdfao "%{file_path}" --sioyek path/to/sioyek -e
 ```
 
 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.4 → pdf_auto_outline-0.1.5}/README.md

@@ -45,6 +45,29 @@ Edit exiting pdf toc:
 A save toc to new pdf from file:
 `pdfao paper.pdf -o new.pdf -i outline.txt`
 
+### Editing
+
+The edit command opens the TOC in the OS default editor (result of 'start' command on Windows and 'EDITOR' environment variable on MacOS and Linux). The file schema is something like this:
+
+```
+Title 1  |  1
+    Title 2  |  2  |  *
+                 ^^^^^^
+				 optional		
+```
+The essential parts of each line are:
+- Indentation - 4 space characters per nesting level (or use tabs with the -t flag).
+- Title text
+- Delimiter - '  |  ' (vertical bar with 2 spaces padding on each side)
+- Page number
+
+The optional part can be one of:
+```
+  |  None                  	same as not including it   
+  |  241.2					y-ordinate 
+  |  Point(72.0, 363.9)		x and y coords
+  |  {<dictionary>}			dictionary with more attributes for the ToC entry
+```
 
 ## For Sioyek Users
 
@@ -52,7 +75,7 @@ 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 %{file_path}" --sioyek path/to/sioyek -e
+new_command _edit_toc pdfao "%{file_path}" --sioyek path/to/sioyek -e
 ```
 
 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.4 → pdf_auto_outline-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pdf-auto-outline"
-version = "0.1.4"
+version = "0.1.5"
 description = "Automatically generate and edit PDF table of contents / outline"
 readme = "README.md"
 authors = [

pdf_auto_outline-0.1.5/src/pdf_auto_outline/__init__.py

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

{pdf_auto_outline-0.1.4 → pdf_auto_outline-0.1.5}/src/pdf_auto_outline/main.py

@@ -159,7 +159,9 @@ def generate_txtfile(toc_entries, txtfile='outline.txt') -> str:
     ============================================================
 
     """)
-    if len(toc_entries[0]) > 3:
+    if not toc_entries:
+        pass
+    elif len(toc_entries[0]) > 3:
         txt += '\n'.join(f"{' '*4 * (i[0] - 1)}{i[1]}  |  {i[2]}  |  {i[3]}" 
                         for i in toc_entries)
     else:
@@ -208,7 +210,7 @@ def embed_toc(pdfpath, toc_entries, newfile=''):
         log(f"toc saved to '{pdfpath}'")
 
 def get_toc_custom(doc) -> list:
-    toc_entries = [[*i[:3], i[3].get('to')] for i in doc.get_toc(False)]
+    toc_entries = [[*i[:3], i[3].get('to')[1]] for i in doc.get_toc(False)]
     return toc_entries
 
 def edit_txtfile(txtfile='outline.txt'):
@@ -232,7 +234,7 @@ 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.4')
+    parser.add_argument('--version', action='version', version='%(prog)s 0.1.5')
 
     args = parser.parse_args()
 

pdf_auto_outline-0.1.4/src/pdf_auto_outline/__init__.py

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