Add subtitle field and allow interactive specification of headers.

knowledge_repo/_version.py

@@ -26,6 +26,7 @@
     'gitpython',  # Git abstraction
     'tabulate',  # Rendering information prettily in knowledge_repo script
     'pyyaml',  # Used to configure knowledge repositories
+    'cooked_input',  # Used for interactive input from user in CLI tooling
 
     # Flask App Dependencies
     'flask',  # Main flask framework

knowledge_repo/app/migrations/versions/d15f6cac07e1_add_subtitle_field_to_post_database.py

@@ -0,0 +1,22 @@
+"""Add subtitle field to post database.
+
+Revision ID: d15f6cac07e1
+Revises: 009eafe4838f
+Create Date: 2018-10-03 12:31:18.462880
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = 'd15f6cac07e1'
+down_revision = '009eafe4838f'
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    op.add_column('posts', sa.Column('subtitle', sa.Text(), nullable=True))
+
+
+def downgrade():
+    op.drop_column('posts', 'subtitle')

knowledge_repo/app/models.py

@@ -365,6 +365,7 @@ class Post(db.Model):
     revision = db.Column(db.Integer())
 
     title = db.Column(db.Text())
+    subtitle = db.Column(db.Text())
     tldr = db.Column(db.Text)
     keywords = db.Column(db.Text)
     thumbnail = db.Column(db.Text())
@@ -597,6 +598,7 @@ def update_metadata_from_kp(self, kp):
         self.repository = kp.repository_uri
         self.revision = kp.revision
         self.title = headers['title']
+        self.subtitle = headers.get('subtitle')
         self.tldr = headers['tldr']
         self.authors = headers.get('authors', [])
         self.tags = headers.get('tags', [])

knowledge_repo/app/static/css/pages/base.css

@@ -1,5 +1,5 @@
 .container-fluid {
-    max-width: 110em;
+    max-width: 100em;
     margin: auto;
 }
 
@@ -307,7 +307,7 @@
 body {
   color: #565a5c;
   background-color: whitesmoke;
-  font-size: 14px;
+  font-size: 12pt;
   font-family: 'Lato', sans-serif;
   /*background-color: #F8F8F8;*/
 }
@@ -328,11 +328,12 @@ ul {
     margin-bottom: 10px;
 }
 
-h1              { font-size: 2em; margin: .67em 0 }
+h1              { font-size: 1.8em; margin: .67em 0 }
 h2              { font-size: 1.5em; margin: .75em 0 }
-h3              { font-size: 1.17em; margin: .83em 0 }
-h5              { font-size: .83em; margin: 1.5em 0 }
-h6              { font-size: .75em; margin: 1.67em 0 }
+h3              { font-size: 1.3em; margin: .83em 0 }
+h4              { font-size: 1.1em; margin: 1em 0 }
+h5              { font-size: 1em; margin: 1.5em 0 }
+h6              { font-size: 1em; margin: 1.67em 0; font-style: italic;}
 h1, h2, h3, h4,
 h5, h6          { font-weight: bolder }
 

knowledge_repo/app/static/css/pages/markdown-base.css

@@ -7,6 +7,7 @@
     margin-bottom: 2em;
     position: relative;
     box-shadow: 0px 2px 3px rgba(0,0,0,0.1);
+    font-size: 12pt;
 }
 
 @media (max-width: 992px) {
@@ -19,24 +20,37 @@
     }
 }
 
+.renderedMarkdown span.title,
 .renderedMarkdown h1,
 .renderedMarkdown h2,
 .renderedMarkdown h3,
 .renderedMarkdown h4,
 .renderedMarkdown h5,
 .renderedMarkdown h6 {
+  color: black;
   margin-top: 1.5em;
   margin-bottom: 0.5em;
   font-weight: bold;
 }
 
-.renderedMarkdown h1:nth-of-type(1) {
+.renderedMarkdown span.title:nth-of-type(1) {
   margin-top: 1em;
   text-align: center;
   display: block;
+  font-size: 2.2em;
+  margin-top: .67em;
+  margin-bottom: .3em;
 }
 
-.renderedMarkdown h2 {
+.renderedMarkdown span.subtitle {
+  text-align: center;
+  display: block;
+  font-size: 1.5em;
+  font-style: italic;
+  margin-bottom: .3em;
+}
+
+.renderedMarkdown h1 {
     border-bottom: 1px solid #eee;
     padding-bottom: 0.3em;
 }
@@ -171,8 +185,8 @@
 
 .renderedMarkdown .codehilite + .code-output  {
   margin-top: -1em;
-  margin-left: -21px;
-  margin-right: -21px;
+  margin-left: -1.5em;
+  margin-right: -1.5em;
   font-family: monospace;
 }
 
@@ -230,8 +244,8 @@
 
 .renderedMarkdown .codehilite {
     margin: 1em;
-    margin-left: -21px;
-    margin-right: -21px;
+    margin-left: -1.5em;
+    margin-right: -1.5em;
     padding: 0px;
 }
 

knowledge_repo/app/templates/markdown-rendered.html

@@ -202,8 +202,7 @@ <h2> {{ comments | length }} Comments </h2>
 })
 
 //Turn all the headers to be links
-//h1 = Title, don't want that
-var all_headers = [$("h2"), $("h3"), $("h4"), $("h5"), $("h6")]
+var all_headers = [$("h1"), $("h2"), $("h3"), $("h4"), $("h5"), $("h6")]
 $.each(all_headers, function(index, value){
   $.each(value, function(i, v){
     var inner_html = v.innerHTML

knowledge_repo/app/utils/render.py

@@ -5,6 +5,7 @@
 
 import pygments
 from flask import url_for
+from jinja2 import Template
 from knowledge_repo.post import KnowledgePost
 
 MARKDOWN_EXTENSIONS = ['extra',
@@ -33,29 +34,32 @@ def render_post_tldr(post):
 
 def render_post_header(post):
 
-    header_template = u"""
+    header_template = Template(u"""
     <div class='metadata'>
-    <h1>{title}</h1>
-    <span class='authors'>{authors}</span>
-    <span class='date_created'>{date_created}</span>
-    <span class='date_updated'>(Last Updated: {date_updated})</span>
-    <span class='tldr'>{tldr}</span>
+    <span class='title'>{{title}}</span>
+    {% if subtitle %}<span class='subtitle'>{{subtitle}}</span>{% endif %}
+    <span class='authors'>{{authors}}</span>
+    <span class='date_created'>{{date_created}}</span>
+    <span class='date_updated'>(Last Updated: {{date_updated}})</span>
+    <span class='tldr'>{{tldr}}</span>
     <span class='tags'></span>
     </div>
-    """
+    """)
 
     def get_authors(usernames, authors):
         authors = [u"<a href='{}'>{}</a>".format(url_for('index.render_feed', authors=username), author) for username, author in zip(usernames, authors)]
         return u' and '.join(u', '.join(authors).rsplit(', ', 1))
 
     if isinstance(post, KnowledgePost):
-        return header_template.format(title=post.headers['title'],
+        return header_template.render(title=post.headers['title'],
+                                      subtitle=post.headers.get('subtitle'),
                                       authors=get_authors(post.headers['authors'], post.headers['authors']),
                                       date_created=post.headers['created_at'].strftime("%B %d, %Y"),
                                       date_updated=post.headers['updated_at'].strftime("%B %d, %Y"),
                                       tldr=render_post_tldr(post))
     else:
-        return header_template.format(title=post.title,
+        return header_template.render(title=post.title,
+                                      subtitle=post.subtitle,
                                       authors=get_authors([author.identifier for author in post.authors], [author.format_name for author in post.authors]),
                                       date_created=post.created_at.strftime("%B %d, %Y"),
                                       date_updated=post.updated_at.strftime("%B %d, %Y"),

knowledge_repo/converter.py

@@ -20,13 +20,14 @@ def get_format(filename, format=None):
 class KnowledgePostConverter(with_metaclass(SubclassRegisteringABCMeta, object)):
     _registry_keys = None  # File extensions
 
-    def __init__(self, kp, format=None, postprocessors=None, **kwargs):
+    def __init__(self, kp, format=None, postprocessors=None, interactive=False, **kwargs):
         check_dependencies(self.dependencies, "Whoops! You are missing some dependencies required to use `{}` instances.".format(self.__class__.__name__))
         self.kp = kp
         self.format = format
         if postprocessors is None:
             postprocessors = [('extract_images', {}), ('format_checks', {})]
         self.postprocessors = postprocessors
+        self.interactive = interactive
         self.init(**kwargs)
 
     @property
@@ -60,6 +61,9 @@ def __getattribute__(self, attr):
             return self.__get_wrapped_with_postprocessors(object.__getattribute__(self, attr))
         return object.__getattribute__(self, attr)
 
+    def kp_write(self, md, headers=None, images={}):
+        return self.kp.write(md, headers=headers, images=images, interactive=self.interactive)
+
     def from_file(self, filename, **opts):
         raise NotImplementedError
 
@@ -73,12 +77,12 @@ def to_string(self, **opts):
         raise NotImplementedError
 
     @classmethod
-    def for_file(cls, kp, filename, format=None, postprocessors=None):
-        return cls.for_format(kp, get_format(filename, format), postprocessors=postprocessors)
+    def for_file(cls, kp, filename, format=None, postprocessors=None, interactive=False):
+        return cls.for_format(kp, get_format(filename, format), postprocessors=postprocessors, interactive=interactive)
 
     @classmethod
-    def for_format(cls, kp, format, postprocessors=None):
+    def for_format(cls, kp, format, postprocessors=None, interactive=False):
         if format.lower() not in cls._registry:
             raise ValueError("The knowledge repository does not support files of type '{}'. Supported types are: {}."
                              .format(format, ','.join(list(cls._registry.keys()))))
-        return cls._get_subclass_for(format.lower())(kp, format=format, postprocessors=postprocessors)
+        return cls._get_subclass_for(format.lower())(kp, format=format, postprocessors=postprocessors, interactive=interactive)

knowledge_repo/converters/ipynb.py

@@ -68,7 +68,7 @@ def from_file(self, filename):
                                        dl], template_file='full.tpl')
         (body, resources) = md_exporter.from_notebook_node(nb)
 
-        self.kp.write(body, images={name.split(
+        self.kp_write(body, images={name.split(
             'images/')[1]: data for name, data in resources.get('outputs', {}).items()})
 
         # Add cleaned ipynb file

knowledge_repo/converters/md.py

@@ -6,4 +6,4 @@ class MdConverter(KnowledgePostConverter):
 
     def from_file(self, filename):
         with open(filename) as f:
-            self.kp.write(f.read())
+            self.kp_write(f.read())

knowledge_repo/converters/pkp.py

@@ -27,6 +27,8 @@ def to_string(self):
         return data.read()
 
     def from_file(self, filename):
+        # Note: header checks are not applied here, since it should not be
+        # possible to create portable knowledge post with incorrect headers.
         zf = zipfile.ZipFile(filename, 'r')
 
         for ref in zf.namelist():

knowledge_repo/converters/rmd.py

@@ -39,7 +39,7 @@ def from_file(self, filename, rebuild=True):
             Rmd_filename = tmp_path
 
         with open(Rmd_filename) as f:
-            self.kp.write(f.read())
+            self.kp_write(f.read())
         self.kp.add_srcfile(filename)
 
         # Clean up temporary file