Split out example and lint

Author: tannewt

README.rst

@@ -28,10 +28,6 @@ This is easily achieved by downloading
 
 Installing from PyPI
 --------------------
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-bitmap_font/>`_. To install for current user:
 
@@ -57,7 +53,13 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+.. code-block::python
+
+    from adafruit_bitmap_font import bitmap_font
+    from displayio import Bitmap
+    font = bitmap_font.load_font("scientifica-11.bdf", Bitmap)
+    print(font.get_glyph(ord("A")))
+
 
 Contributing
 ============

adafruit_bitmap_font/bitmap_font.py

@@ -61,30 +61,3 @@ def load_font(filename, bitmap=None):
         import ttf
         return ttf.TTF(font_file)
     return None
-
-if __name__ == "__main__":
-    #pylint: disable=invalid-name
-    import os
-    import sys
-    sys.path.append(os.path.join(sys.path[0], "test"))
-    font = load_font(sys.argv[1])
-
-    _, height, _, dy = font.get_bounding_box()
-    for y in range(height):
-        for c in "Adafruit CircuitPython":
-            glyph = font.get_glyph(ord(c))
-            if not glyph:
-                continue
-            glyph_y = y + (glyph.height - (height + dy)) + glyph.dy
-            pixels = []
-            if 0 <= glyph_y < glyph.height:
-                for i in range(glyph.width):
-                    value = glyph.bitmap[i, glyph_y]
-                    pixel = " "
-                    if value > 0:
-                        pixel = "#"
-                    pixels.append(pixel)
-            else:
-                pixels = ""
-            print("".join(pixels) + " " * (glyph.shift_x - len(pixels)), end="")
-        print()

docs/conf.py

@@ -20,7 +20,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["displayio"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/index.rst

@@ -23,15 +23,9 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Other Links
 

examples/bitmap_font_simpletest.py

@@ -0,0 +1,28 @@
+# Call this with the font file as the command line argument.
+
+import os
+import sys
+
+from adafruit_bitmap_font import bitmap_font
+sys.path.append(os.path.join(sys.path[0], "test"))
+font = bitmap_font.load_font(sys.argv[1])
+
+_, height, _, dy = font.get_bounding_box()
+for y in range(height):
+    for c in "Adafruit CircuitPython":
+        glyph = font.get_glyph(ord(c))
+        if not glyph:
+            continue
+        glyph_y = y + (glyph.height - (height + dy)) + glyph.dy
+        pixels = []
+        if 0 <= glyph_y < glyph.height:
+            for i in range(glyph.width):
+                value = glyph.bitmap[i, glyph_y]
+                pixel = " "
+                if value > 0:
+                    pixel = "#"
+                pixels.append(pixel)
+        else:
+            pixels = ""
+        print("".join(pixels) + " " * (glyph.shift_x - len(pixels)), end="")
+    print()