Merge pull request #51 from homeylab/47-create-local-export-dump-directory-if-not-exists

pchang388 · web-flow · commit c80f302109b7 · 2024-11-06T05:51:33.000-05:00
minor fix on logging and output description
diff --git a/README.md b/README.md
@@ -248,7 +248,7 @@ More descriptions can be found for each section below:
 | `credentials.token_secret` | `str` | `true` if `credentials`| If `credentials` section is given, this should be a valid tokenSecret | 
 | `additional_headers` | `object` | `false` | Optional section where key/value for pairs can be specified to use in Bookstack http request headers.
 | `formats` | `list<str>` | `true` | Which export formats to use for Bookstack page content. Valid options are: `["markdown", "html", "pdf", "plaintext"]`|
-| `output_path` | `str` | `false` | Optional (default: `cwd`) which directory (relative or full path) to place exports. User who runs the command should have access to read/write to this directory. This directory and any parent directories will be attempted to be created if they do not exist. If not provided, will use current run directory by default.|
+| `output_path` | `str` | `false` | Optional (default: `cwd`) which directory (relative or full path) to place exports. User who runs the command should have access to read/write to this directory. This directory and any parent directories will be attempted to be created if they do not exist. If not provided, will use current run directory by default. If using docker, this option can be omitted. |
 | `assets` | `object` | `false` | Optional section to export additional assets from pages. |
 | `assets.export_images` | `bool` | `false` | Optional (default: `false`), export all images for a page to an `image` directory within page directory. See [Backup Behavior](#backup-behavior) for more information on layout |
 | `assets.export_attachments` | `bool` | `false` | Optional (default: `false`), export all attachments for a page to an `attachments` directory within page directory. See [Backup Behavior](#backup-behavior) for more information on layout |
diff --git a/bookstack_file_exporter/archiver/archiver.py b/bookstack_file_exporter/archiver/archiver.py
@@ -47,8 +47,8 @@ def create_export_dir(self):
             util.create_dir(self.config.user_inputs.output_path)
         except PermissionError as perm_err:
             log.warning("Failed to create base directory: %s", perm_err)
-            log.warning("This usually occurs in docker environments, \
-                        attempting to skip this step")
+            log.warning("This usually occurs in docker environments" \
+                        "attempting to skip this step")
             return
 
     def get_bookstack_exports(self, page_nodes: Dict[int, Node]):
