include more comments

Author: rgbkrk

bookstore/archive.py

@@ -28,6 +28,7 @@ class BookstoreContentsArchiver(FileContentsManager):
 
     def __init__(self, *args, **kwargs):
         super(FileContentsManager, self).__init__(*args, **kwargs)
+        # opt ourselves into being part of the Jupyter App that should have Bookstore Settings applied
         self.settings = BookstoreSettings(parent=self)
 
         self.fs = s3fs.S3FileSystem(key=self.settings.s3_access_key_id,
@@ -41,7 +42,8 @@ def __init__(self, *args, **kwargs):
 
     @property
     def delimiter(self):
-        """Normally this is overridable, for now just keeping this consistent"""
+        """It's a slash! Normally this could be configurable. This leaves room for that later,
+        keeping it centralized for now"""
         return "/"
 
     @property
@@ -50,6 +52,7 @@ def full_prefix(self):
         return self.delimiter.join([self.settings.s3_bucket, self.settings.workspace_prefix])
 
     def s3_path(self, path):
+        """compute the s3 path based on the bucket, prefix, and the path to the notebook"""
         return self.delimiter.join([self.full_prefix, path])
 
     def run_pre_save_hook(self, model, path, **kwargs):

bookstore/bookstore_config.py

@@ -14,6 +14,9 @@
 from traitlets.config import LoggingConfigurable
 
 class BookstoreSettings(LoggingConfigurable):
+    """The same settings to be shared across archival, publishing, and scheduling
+    """
+
     workspace_prefix = Unicode("workspace", help="Prefix for the live workspace notebooks").tag(config=True)
     published_prefix = Unicode("published", help="Prefix for published notebooks").tag(config=True)
 
@@ -33,5 +36,5 @@ class BookstoreSettings(LoggingConfigurable):
         "us-east-1", help="Region name").tag(
             config=True, env="JPYNB_S3_REGION_NAME")
     s3_bucket = Unicode(
-        "notebooks", help="Bucket name to store notebooks").tag(
+        "bookstore", help="Bucket name to store notebooks").tag(
             config=True, env="JPYNB_S3_BUCKET")