move data directory into package

README.md

@@ -60,7 +60,7 @@ $ dphon --version
 
 ## methodology
 
-matching sequences are determined by a dictionary file that represents a particular reconstruction of old chinese phonology (you can see some examples in the `data/` folder). these data structures map an input character to an arbitrary sound token ("dummy") that can be matched against other such tokens.
+matching sequences are determined by a dictionary file that represents a particular reconstruction of old chinese phonology (you can see some examples in the `dphon/data/` folder). these data structures map an input character to an arbitrary sound token ("dummy") that can be matched against other such tokens.
 
 the core process of DIRECT is to accept plaintext input, tokenize it according to a particular phonological reconstruction, and search for matches amongst the tokenized text. these matches thus represent resonance: sequences that could have rhymed when they were originally read aloud, despite dissimilarity in their written forms.
 

dphon/lib.py

@@ -1,12 +1,16 @@
 import json
 from collections import defaultdict
-from typing import List, Dict, Tuple
 from os.path import basename, splitext
+from typing import Dict, List, Tuple
+
+import pkg_resources
 
 '''Non-alphabetic symbols used in place of a character.'''
 CHAR_MARKERS = ['□']
 
-with open('data/dummy_dict.json', encoding='utf-8') as file:
+'''Dictionary based on Schuessler's reconstruction of Old Chinese.'''
+schuessler_path = pkg_resources.resource_filename(__package__, 'data/dummy_dict.json')
+with open(schuessler_path, encoding='utf-8') as file:
     DUMMY_DICT = json.loads(file.read())
 
 def phonetic_tokens(string: str) -> str:

setup.py

@@ -39,7 +39,8 @@ def run(self):
     long_description=long_description,
     long_description_content_type='text/markdown',
     url='https://github.com/direct-phonology/direct',
-    include_package_data=True,  # include extra data files, e.g. dictionaries
+    include_package_data=True,
+    package_data={'dphon': ['data/*.json']},
     author='John O\'Leary, Nick Budak, Gian Rominger',
     author_email='jo10@princeton.edu, nbudak@princeton.edu, gianr@princeton.edu',
     license='MIT',