Merge pull request flaskcwg#83 from mmdbalkhi/pr

lint the code and add logging to static.py

Author: Abdur-rahmaanJ

CONTRIBUTING.md

@@ -52,4 +52,3 @@
     ```
 
 * Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote "fork", the default Pallets remote is "origin".
-

docs/serve.py

@@ -4,16 +4,15 @@
 
 # tasklist
 # /IM py37.exe /F
-# 
+#
 hostname = socket.gethostname()
 PORT = 8000
 IP = socket.gethostbyname(hostname)
 
 Handler = http.server.SimpleHTTPRequestHandler
-with socketserver.TCPServer(('', PORT), Handler) as httpd:
+with socketserver.TCPServer(("", PORT), Handler) as httpd:
     print(f"Serving on: {IP}:{PORT}")
     try:
         httpd.serve_forever()
     except KeyboardInterrupt:
         print("Shutting down serve.py...")
-

info.json

@@ -169,9 +169,11 @@
             "retired": "n"
         },
         "mmdbalkhi":{
-            "name": "Mohamad Balkhi ",
+            "name": "Komeil Parseh",
             "bio": [],
+            "links": {"GitHub":"https://github.com/mmdbalkhi", "twitter":"https://twitter.com/mmdbalkhi"},
             "volunteer": {
+                "code": {},
                 "translation":{
                     "lang": "persian",
                     "coordinator": "y"

manager.py

@@ -1,105 +1,119 @@
 import datetime
+import ntpath
 import shutil
 
 import markdown
-import ntpath
 from flask import Flask, redirect, render_template, request, url_for
+
 from manager_utils import *
 from settings import BLOG_CATEGORIES
 
-app = Flask(__name__, template_folder='manager_app/templates', static_folder='manager_app/static')
+app = Flask(
+    __name__,
+    template_folder="manager_app/templates",
+    static_folder="manager_app/static",
+)
 app.config.update(
-    DEBUG=True,
-    SECRET_KEY=b'sC&wJQ35C3jR',
-    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    DEBUG=True, SECRET_KEY=b"sC&wJQ35C3jR", SQLALCHEMY_TRACK_MODIFICATIONS=False
 )
 
+
 @app.route("/")
 def index():
     posts = get_posts()
-    resources = info['resources']
+    resources = info["resources"]
     current_day = datetime.date.today()
     today = datetime.date.strftime(current_day, "%B %d, %Y")
 
-    return render_template("index.html", today=today,
-                                         b_categories=BLOG_CATEGORIES,
-                                         posts=posts,
-                                         resources=resources)
+    return render_template(
+        "index.html",
+        today=today,
+        b_categories=BLOG_CATEGORIES,
+        posts=posts,
+        resources=resources,
+    )
+
 
-@app.route("/save_post", methods=['POST'])
+@app.route("/save_post", methods=["POST"])
 def save_post():
     # Validate empty fields?
-    post_type = request.form['post-type']
-    if request.form['post-type'] == 'blog':
+    post_type = request.form["post-type"]
+    if request.form["post-type"] == "blog":
         data = {
-            'title' : request.form['b_title'],
-            'summary' : request.form['b_summ'],
-            'authors' : get_comma_separated(request.form['b_authors']),
-            'date' : request.form['b_date'],
-            'tags' : get_comma_separated(request.form['b_tags']),
-            'slug' : request.form['b_slug'],
-            'post_content' : request.form['post_content'],
-            'category' : request.form['b_category']
+            "title": request.form["b_title"],
+            "summary": request.form["b_summ"],
+            "authors": get_comma_separated(request.form["b_authors"]),
+            "date": request.form["b_date"],
+            "tags": get_comma_separated(request.form["b_tags"]),
+            "slug": request.form["b_slug"],
+            "post_content": request.form["post_content"],
+            "category": request.form["b_category"],
         }
 
-        ensure_authors(data['authors'])
+        ensure_authors(data["authors"])
         save_md_file(post_type, data)
 
     else:
         data = {
-            'slug' : request.form['f_slug'],
-            'tags' : get_comma_separated(request.form['f_tags']),
-            'title' : request.form['f_title'],
-            'post_content' : request.form['post_content']
+            "slug": request.form["f_slug"],
+            "tags": get_comma_separated(request.form["f_tags"]),
+            "title": request.form["f_title"],
+            "post_content": request.form["post_content"],
         }
         save_md_file(post_type, data)
-    
+
     return 'Post saved! Remember re-build the site to see the changes. <a href="/">Return</a>'
-    
-@app.route("/action/<string:ptype>/<string:option>/<string:post>", methods=['GET'])
+
+
+@app.route("/action/<string:ptype>/<string:option>/<string:post>", methods=["GET"])
 def postman(ptype, option, post):
-    if option == 'edit':
+    if option == "edit":
         posts = get_posts()
 
-        if ptype == 'blog':
-            filename, category = post.split('@')
-            blog_post_path = os.path.join('data', 'blog', category, filename)
-            
+        if ptype == "blog":
+            filename, category = post.split("@")
+            blog_post_path = os.path.join("data", "blog", category, filename)
+
             body, metadata = parse_file(blog_post_path)
 
             postdata = {
-                "title" : metadata["title"][0],
-                "summary" : metadata["summary"][0],
-                "authors" : ','.join(metadata["authors"]),
-                "date" : metadata["date"][0],
-                "tags" : ','.join(metadata["tags"]),
-                "slug" : metadata["slug"][0],
-                "category" : category,
-                "content": body
+                "title": metadata["title"][0],
+                "summary": metadata["summary"][0],
+                "authors": ",".join(metadata["authors"]),
+                "date": metadata["date"][0],
+                "tags": ",".join(metadata["tags"]),
+                "slug": metadata["slug"][0],
+                "category": category,
+                "content": body,
             }
-            
-            return render_template("edit_page.html", postdata=postdata, posts=posts, edit_type='blog')
+
+            return render_template(
+                "edit_page.html", postdata=postdata, posts=posts, edit_type="blog"
+            )
         else:
-            faq_post_path = os.path.join('data', 'faq', post)
+            faq_post_path = os.path.join("data", "faq", post)
             body, metadata = parse_file(faq_post_path)
 
             postdata = {
-                "title" : metadata["title"][0],
-                "tags" : ','.join(metadata["tags"]),
-                "slug" : metadata["slug"][0],
-                "content": body
+                "title": metadata["title"][0],
+                "tags": ",".join(metadata["tags"]),
+                "slug": metadata["slug"][0],
+                "content": body,
             }
-            
-            return render_template("edit_page.html", postdata=postdata, posts=posts, edit_type='faq')
+
+            return render_template(
+                "edit_page.html", postdata=postdata, posts=posts, edit_type="faq"
+            )
 
     else:
-        if ptype == 'blog':
-            filename, category = post.split('@')
-            delete_post(os.path.join('data', 'blog', category, filename), docs_dir='b')
+        if ptype == "blog":
+            filename, category = post.split("@")
+            delete_post(os.path.join("data", "blog", category, filename), docs_dir="b")
         else:
-            delete_post(os.path.join('data', 'faq', post), docs_dir='faq')
+            delete_post(os.path.join("data", "faq", post), docs_dir="faq")
 
         return 'Post deleted! Do not forget to rebuild the site to remove the remaining references. <a href="/">Return</a>'
 
+
 if __name__ == "__main__":
     app.run()

manager_utils.py

@@ -2,87 +2,94 @@
 import shutil
 
 import markdown
+
 from settings import info
 
 
 class AuthorNotFound(Exception):
     def __init__(self, author, message="Author not found"):
         self.author = author
-        self.message = f'{message}: {author}'
+        self.message = f"{message}: {author}"
         super().__init__(self.message)
 
+
 def get_posts():
-    '''Get blog and faq post'''
-    blogs_dir = os.listdir('data/blog')
-    faqs = os.listdir('data/faq')
+    """Get blog and faq post"""
+    blogs_dir = os.listdir("data/blog")
+    faqs = os.listdir("data/faq")
 
     blogs = []
     for category in blogs_dir:
-        bposts = os.listdir(os.path.join('data', 'blog', category))
+        bposts = os.listdir(os.path.join("data", "blog", category))
         for post in bposts:
             blogs.append([post, category])
 
-    data = {'blogs':blogs, 'faqs':faqs}
-    
+    data = {"blogs": blogs, "faqs": faqs}
+
     return data
 
+
 def delete_post(filePath, docs_dir):
-    '''Delete post .md file and rendered files in docs'''
+    """Delete post .md file and rendered files in docs"""
     # First, delete main .md file (in data folder)
-    os.remove(filePath) 
-   
+    os.remove(filePath)
+
     # Second, delete folder from docs folder
-    shutil.rmtree(os.path.join('docs', docs_dir, ntpath.basename(filePath)[:-3]))
+    shutil.rmtree(os.path.join("docs", docs_dir, ntpath.basename(filePath)[:-3]))
+
 
 def format_authors_tags(items):
-    '''Format authors and tags to be compatible with Markdown metadata'''
-    s = ''
+    """Format authors and tags to be compatible with Markdown metadata"""
+    s = ""
     count = 0
     for item in items:
         count += 1
         if count > 1:
             # More than one author
-            s += f'    {item}\n'
+            s += f"    {item}\n"
         else:
-            s += f'{item}\n'
-    
+            s += f"{item}\n"
+
     return s.strip()
 
+
 def get_comma_separated(string):
-    '''Get items in comma separated string and clean whitespaces'''
-    result = [x.strip() for x in string.split(',')]
+    """Get items in comma separated string and clean whitespaces"""
+    result = [x.strip() for x in string.split(",")]
     return result
 
+
 def get_md_template(post_type):
-    '''Return given template content'''
-    with open(f'manager_app/templates/post.{post_type}.md') as f:
+    """Return given template content"""
+    with open(f"manager_app/templates/post.{post_type}.md") as f:
         content = f.read()
         return content
 
+
 def ensure_authors(authors):
-    '''Verify if given authors are valid flaskcwg members'''
+    """Verify if given authors are valid flaskcwg members"""
     for author in authors:
         if author not in info["profiles"]:
             raise AuthorNotFound(author)
 
 
 def get_file_body(file_lines):
-    '''Get body of file content without metadata'''
+    """Get body of file content without metadata"""
     indicestoremove = []
     for n, line in enumerate(file_lines):
         indicestoremove.append(n)
-        if 'slug:' in line:
+        if "slug:" in line:
             break
 
     for index in sorted(indicestoremove, reverse=True):
         file_lines.pop(index)
 
-    body = ''.join(file_lines)
+    body = "".join(file_lines)
     return body
 
 
 def parse_file(file_path):
-    '''Open, get and return conntent of given file'''
+    """Open, get and return conntent of given file"""
     with open(file_path, encoding="utf-8") as f:
         text = f.read()
     with open(file_path, encoding="utf-8") as f2:
@@ -98,27 +105,28 @@ def parse_file(file_path):
 
 
 def save_md_file(post_type, data):
-    '''Save post to respective category (blog, faq)'''
+    """Save post to respective category (blog, faq)"""
     template = get_md_template(post_type)
-    slug = data['slug']
-
-    if post_type == 'blog':
-        category = data['category']
-        post = template.format(data['title'],
-                               data['summary'],
-                               format_authors_tags(data['authors']),
-                               data['date'],
-                               format_authors_tags(data['tags']),
-                               slug,
-                               data['post_content'])
-
-        with open(f'data/blog/{category}/{slug}.md', 'w') as f:
+    slug = data["slug"]
+
+    if post_type == "blog":
+        category = data["category"]
+        post = template.format(
+            data["title"],
+            data["summary"],
+            format_authors_tags(data["authors"]),
+            data["date"],
+            format_authors_tags(data["tags"]),
+            slug,
+            data["post_content"],
+        )
+
+        with open(f"data/blog/{category}/{slug}.md", "w") as f:
             f.write(post)
     else:
-        post = template.format(data['title'],
-                               format_authors_tags(data['tags']),
-                               slug,
-                               data['post_content'])
+        post = template.format(
+            data["title"], format_authors_tags(data["tags"]), slug, data["post_content"]
+        )
 
-        with open(f'data/faq/{slug}.md', 'w') as f:
+        with open(f"data/faq/{slug}.md", "w") as f:
             f.write(post)