Added pelican-gfm plugin

pelican-gfm/Readme.md

@@ -37,6 +37,10 @@ Before Pelican GFM run it checks:
 If Pelican GFM finds that there is a configuration issue it will recommend that you run the following:
 	`python gfmSetup.py`
 
+## Testing
+
+There is a unittest written for gfm. the test will register and spawn a new reader and return true if there were no issues.
+
 Syntax
 ======
 This plugin leverages [GitHub Flavored Markdown](https://github.github.com/gfm/) in `md, markdown, mkd, mdown` files to generate html pages.

pelican-gfm/gfm.py

@@ -29,8 +29,16 @@
 import pelican.utils
 import pelican.signals
 import pelican.readers
-from . import gfmSetup
-from . import Settings
+
+try:
+    from . import gfmSetup
+except ImportError:
+    import gfmSetup
+
+try:
+    from . import Settings
+except:
+    import Settings
 
 _LIBDIR = Settings.LIBCMARKLOCATION
 _LIBCMARK = 'libcmark-gfm.so'
@@ -204,13 +212,15 @@ def render(self, text):
 
 def add_readers(readers):
     msg = "GFM plugin cannot find the required libcmark files.\
- Please run python gfmSetup.py to build and\
- configure the appropriate libcmark files"
+ Please run python3 gfmSetup.py as a user with write permission \
+ to the directory into which the libcmark files will be placed."
     if gfmSetup.test_configuration():
         readers.reader_classes['md'] = GFMReader
+        return True
     else:
         raise Exception(msg)
 
 
 def register():
-    pelican.signals.readers_init.connect(add_readers)
+    reader = pelican.signals.readers_init.connect(add_readers)
+    return(reader)

pelican-gfm/gfmSetup.py

@@ -4,6 +4,7 @@
 import os
 import subprocess
 import shutil
+import tarfile
 
 # Importing in python2 and python3 is different
 # for these for some reason. this should catch
@@ -89,20 +90,16 @@ def setup():
             subprocess.call([
                              "wget",
                              "--quiet",
-                             Settings.ARCHIVES + "/" + Settings.VERSION + ".tar.gz",
+                             os.path.join(Settings.ARCHIVES, Settings.VERSION + ".tar.gz"),
                              WORKSPACE,
                              "-P",
                              WORKSPACE
                              ])
+
             # Untar the files
-            subprocess.call([
-                             'tar',
-                             'zxf',
-                             WORKSPACE + "/" + Settings.VERSION + ".tar.gz",
-                             "-C",
-                             WORKSPACE
-                             ]
-                            )
+            tf = tarfile.open(os.path.join(WORKSPACE, Settings.VERSION + ".tar.gz"))
+            tf.extractall(path=WORKSPACE)
+
             # Create a buildspace for your cmake operation
             BUILDSPACE = WORKSPACE + "/cmark-gfm-" + Settings.VERSION + "/build"
 

pelican-gfm/test.py

@@ -0,0 +1,17 @@
+#!/usr/bin/python -B
+
+import unittest
+
+# python2 and python3 differ on how to do this it seems
+try:
+    from .gfm import *
+except ImportError:
+    import gfm
+
+class gfmTest(unittest.TestCase):
+
+    def test_for_gfm(self):
+        self.assertTrue(gfm.register())
+
+if __name__ == '__main__':
+    unittest.main()