refactored dev scripts (#386)

Co-authored-by: Grey Li <[email protected]>

Author: PanderMusubi

examples/README.rst

@@ -42,5 +42,5 @@ with:
 
 .. code-block:: bash
 
-    $ python3 update-icons.py
+    $ python3 update_icons.py
 

examples/bootstrap4/app.py

@@ -97,8 +97,7 @@ class ContactForm(FlaskForm):
 
 class BootswatchForm(FlaskForm):
     """Form to test Bootswatch."""
-
-    # DO NOT EDIT! Use list-bootswatch.py to generate the Radiofield below.
+    # DO NOT EDIT! Use list_bootswatch.py to generate the Radiofield below.
     theme_name = RadioField(
         default='default',
         choices=[

examples/bootstrap4/templates/icons.html

@@ -1,10 +1,10 @@
 {% extends 'base.html' %}
 {% from 'bootstrap4/utils.html' import render_icon %}
-<!-- DO NOT EDIT! Use update-icons.py for updating this file. -->
+<!-- DO NOT EDIT! Use update_icons.py for updating this file. -->
 
 {% block content %}
 <h2>Icons</h2>
-<p>These are all the icons which are currently supported by Bootstrap-Flask.</p>
+<p>These are all the icons currently supported by Bootstrap-Flask.</p>
 <ul class="row row-cols-3 row-cols-sm-4 row-cols-lg-6 row-cols-xl-8 list-unstyled list">
 <li class="col mb-4">
 <a class="d-block text-dark text-body-emphasis text-decoration-none" href="https://icons.getbootstrap.com/icons/0-circle/">
@@ -16409,4 +16409,3 @@ <h2>Icons</h2>
 </ul>
 <p>This is a total of 2050 icons.</p>
 {% endblock %}
-

examples/bootstrap5/app.py

@@ -98,7 +98,7 @@ class ContactForm(FlaskForm):
 class BootswatchForm(FlaskForm):
     """Form to test Bootswatch."""
 
-    # DO NOT EDIT! Use list-bootswatch.py to generate the Radiofield below.
+    # DO NOT EDIT! Use list_bootswatch.py to generate the Radiofield below.
     theme_name = RadioField(
         default='default',
         choices=[

examples/bootstrap5/templates/icons.html

@@ -1,10 +1,10 @@
 {% extends 'base.html' %}
 {% from 'bootstrap5/utils.html' import render_icon %}
-<!-- DO NOT EDIT! Use update-icons.py for updating this file. -->
+<!-- DO NOT EDIT! Use update_icons.py for updating this file. -->
 
 {% block content %}
 <h2>Icons</h2>
-<p>These are all the icons which are currently supported by Bootstrap-Flask.</p>
+<p>These are all the icons currently supported by Bootstrap-Flask.</p>
 <ul class="row row-cols-3 row-cols-sm-4 row-cols-lg-6 row-cols-xl-8 list-unstyled list">
 <li class="col mb-4">
 <a class="d-block text-dark text-body-emphasis text-decoration-none" href="https://icons.getbootstrap.com/icons/0-circle/">
@@ -16409,4 +16409,3 @@ <h2>Icons</h2>
 </ul>
 <p>This is a total of 2050 icons.</p>
 {% endblock %}
-

examples/list-bootswatch.py examples/list_bootswatch.pyexamples/list-bootswatch.py renamed to examples/list_bootswatch.py

@@ -2,8 +2,10 @@
 
 from os import listdir
 
+# pylint:disable=unspecified-encoding
 
-def list(version):
+
+def list_names(version):
     """List template file names."""
     print(f"To add to bootstrap{version}/app.py")
     print("    theme_name = RadioField(")
@@ -23,4 +25,4 @@ def list(version):
 
 
 for value in (4, 5):
-    list(value)
+    list_names(value)

examples/update-icons.py examples/update_icons.pyexamples/update-icons.py renamed to examples/update_icons.py

@@ -1,33 +1,38 @@
-'''Generate example page with overview of all icons.'''
+"""Generate example page with overview of all icons."""
 
 from lxml import etree
 
+# pylint:disable=unspecified-encoding
+
+
 def parse(filename):
-    '''Parse SVG file containing icons.'''
+    """Parse SVG file containing icons."""
     symbols = set()
     data = etree.parse(filename)
     svg = data.getroot()
     for symbol in svg:
         symbols.add(symbol.attrib['id'])
     return sorted(symbols)
 
+
 def generate(version):
-    '''Write the HTML template file.'''
+    """Write the HTML template file."""
     head = f'''{{% extends 'base.html' %}}
 {{% from 'bootstrap{version}/utils.html' import render_icon %}}
-<!-- DO NOT EDIT! Use update-icons.py for updating this file. -->
+<!-- DO NOT EDIT! Use update_icons.py for updating this file. -->
 
 {{% block content %}}
 <h2>Icons</h2>
-<p>These are all the icons which are currently supported by Bootstrap-Flask.</p>
+<p>These are all the icons currently supported by Bootstrap-Flask.</p>
 <ul class="row row-cols-3 row-cols-sm-4 row-cols-lg-6 row-cols-xl-8 list-unstyled list">
 '''
-    names = parse(f'../flask_bootstrap/static/bootstrap{version}/icons/bootstrap-icons.svg')
-    with open(f'bootstrap{version}/templates/icons.html', 'w') as file:  # pylint:disable=unspecified-encoding
+    names = parse(f'../flask_bootstrap/static/bootstrap{version}/icons'
+                  '/bootstrap-icons.svg')
+    with open(f'bootstrap{version}/templates/icons.html', 'w') as file:
         file.write(head)
         number = 0
         for name in sorted(names):
-            item=f'''<li class="col mb-4">
+            item = f'''<li class="col mb-4">
 <a class="d-block text-dark text-body-emphasis text-decoration-none" href="https://icons.getbootstrap.com/icons/{name}/">
 <div class="px-3 py-4 mb-2 bg-light text-center rounded">
 {{{{ render_icon('{name}', 32) }}}}
@@ -40,8 +45,9 @@ def generate(version):
             number += 1
         file.write('</ul>\n')
         file.write(f'<p>This is a total of {number} icons.</p>\n')
-        file.write('{% endblock %}\n\n')
-        print(f'For Bootstrap{version}, a total of {number} icons are supported.')
+        file.write('{% endblock %}\n')
+        print(f'For Bootstrap{version} {number} icons are supported.')
+
 
 for value in (4, 5):
     generate(value)