Update resources to load for pypi builds.

Author: haydenjackson01

README.rst

@@ -1,5 +1,4 @@
-.. figure:: verto/images/verto-logo.png
-   :alt: Verto Logo
+|Verto Image|
 
 |Build Status| |Code Climate Status|
 
@@ -52,3 +51,7 @@ The changelog is available within the `documentation`_.
 .. |Code Climate Status| image:: https://codeclimate.com/github/uccser/verto/badges/gpa.svg
   :target: https://codeclimate.com/github/uccser/verto
   :alt: Code Climate
+
+.. |Verto Image| image:: https://raw.githubusercontent.com/uccser/verto/master/verto/images/verto-logo.png
+  :target: https://github.com/uccser/verto
+  :alt: Verto GitHub

requirements.txt

@@ -3,6 +3,7 @@ markdown==2.6.8
 beautifulsoup4==4.5.3
 Jinja2==2.9.6
 python-slugify==1.2.2
+pkg_resources
 
 # Required dependencies for building documentation
 sphinx==1.5.5

setup.py

@@ -12,6 +12,7 @@
     long_description=open('README.rst').read(),
     url='https://github.com/uccser/verto',
     author='University of Canterbury Computer Science Education Research Group',
+    author_email='csse-education-research@canterbury.ac.nz',
     license='MIT',
     classifiers=[
         'Development Status :: 3 - Alpha',
@@ -25,13 +26,13 @@
         'Topic :: Text Processing :: Markup',
         'Topic :: Text Processing :: Markup :: HTML'
     ],
+    keywords='markdown verto development textbook converter media richtext interactive education html book author extension',
     packages=find_packages(),
     include_package_data=True,
     install_requires=[
         'markdown>=2.6.8',
-        'bs4>=0.0.1',
-        'Jinja2>=2.9.5',
-        'python-slugify>=1.2.1'
-    ],
-    zip_safe=False
+        'beautifulsoup4==4.5.3',
+        'Jinja2>=2.9.6',
+        'python-slugify>=1.2.2'
+    ]
 )

verto/VertoExtension.py

@@ -32,6 +32,7 @@
 import json
 
 from jinja2 import Environment, PackageLoader, select_autoescape
+import pkg_resources
 
 
 class VertoExtension(Extension):
@@ -204,7 +205,7 @@ def loadProcessorInfo(self):
         Returns:
             The json object of the file where objects are ordered dictionaries.
         '''
-        json_data = open(os.path.join(os.path.dirname(__file__), 'processor-info.json')).read()
+        json_data = pkg_resources.resource_string('verto', 'processor-info.json').decode('utf-8')
         return json.loads(json_data, object_pairs_hook=OrderedDict)
 
     def get_heading_tree(self):

verto/tests/BaseTest.py

@@ -1,4 +1,6 @@
 import unittest
+import pkg_resources
+
 
 class BaseTest(unittest.TestCase):
     '''A base test class for individual test classes.'''
@@ -11,7 +13,7 @@ def __init__(self, *args, **kwargs):
         test failures.
         '''
         unittest.TestCase.__init__(self, *args, **kwargs)
-        self.test_file_path = 'verto/tests/assets/{test_type}/{filename}'
+        self.test_file_path = 'tests/assets/{test_type}/{filename}'
         self.maxDiff = None
 
     def read_test_file(self, test_type, filename, strip=False):
@@ -20,8 +22,7 @@ def read_test_file(self, test_type, filename, strip=False):
         This function reads a file from a given filename in UTF-8 encoding.
         '''
         file_path = self.test_file_path.format(test_type=test_type, filename=filename)
-        file_object = open(file_path, encoding='utf-8')
-        text =  file_object.read()
+        text = pkg_resources.resource_string('verto', file_path).decode('utf-8')
         if strip:
             text = text.rstrip('\r\n')
         return text

verto/tests/ProcessorTest.py

@@ -1,4 +1,5 @@
 import unittest
+import pkg_resources
 import json
 import markdown
 from verto.VertoExtension import VertoExtension
@@ -36,7 +37,7 @@ def loadJinjaTemplate(self, template):
     def loadProcessorInfo(self):
         '''Loads the processor info similar to the verto extension.
         '''
-        pattern_data = open('verto/processor-info.json').read()
+        pattern_data = pkg_resources.resource_string('verto', 'processor-info.json').decode('utf-8')
         return json.loads(pattern_data)
 
     def to_blocks(self, string):

verto/tests/SmokeTests.py

@@ -1,4 +1,5 @@
 import unittest, os, subprocess
+import pkg_resources
 from verto import Verto
 
 class SmokeDocsTest(unittest.TestCase):
@@ -9,7 +10,7 @@ def __init__(self, *args, **kwargs):
         self.maxDiff = None
         self.build_path = 'docs/build'
 
-    @unittest.skipIf(not os.path.isdir('docs') and os.name not in ['nt', 'posix'], 'Docs are not present')
+    @unittest.skipIf(not pkg_resources.resource_isdir('verto', 'docs') and os.name not in ['nt', 'posix'], 'Docs are not present')
     def test_compile_docs(self):
         '''This test is skipped if the docs directory is not found.
         '''
@@ -42,7 +43,7 @@ def __init__(self, *args, **kwargs):
         unittest.TestCase.__init__(self, *args, **kwargs)
         self.maxDiff = None
         self.verto = None
-        self.assets_template = 'verto/tests/assets/smoke/{}'
+        self.assets_template = 'tests/assets/smoke/{}'
 
     def setUp(self):
         '''Run before any testcases.
@@ -58,14 +59,13 @@ def test_compile_files(self):
         '''Tests that some example files are converted.
         '''
         for chapter in ['algorithms.md', 'introduction.md']:
-            with open(self.assets_template.format(chapter), 'r') as f:
-                text = f.read()
-                result = self.verto.convert(text)
+            text = pkg_resources.resource_string('verto', self.assets_template.format(chapter)).decode('utf-8')
+            result = self.verto.convert(text)
 
-                self.assertIsNot(result, None)
-                self.assertIsNot(result.title, None)
-                self.assertIsNot(result.html_string, None)
-                self.assertTrue(len(result.html_string) > 0)
+            self.assertIsNot(result, None)
+            self.assertIsNot(result.title, None)
+            self.assertIsNot(result.html_string, None)
+            self.assertTrue(len(result.html_string) > 0)
 
     def test_compile_files_custom(self):
         '''Tests that some example files are converted with custom
@@ -78,11 +78,10 @@ def test_compile_files_custom(self):
 
         verto = Verto(html_templates=custom_templates)
         for chapter in ['algorithms.md', 'introduction.md']:
-            with open(self.assets_template.format(chapter), 'r') as f:
-                text = f.read()
-                result = verto.convert(text)
+            text = pkg_resources.resource_string('verto', self.assets_template.format(chapter)).decode('utf-8')
+            result = verto.convert(text)
 
-                self.assertIsNot(result, None)
-                self.assertIsNot(result.title, None)
-                self.assertIsNot(result.html_string, None)
-                self.assertTrue(len(result.html_string) > 0)
+            self.assertIsNot(result, None)
+            self.assertIsNot(result.title, None)
+            self.assertIsNot(result.html_string, None)
+            self.assertTrue(len(result.html_string) > 0)