Closed sammcdsam closed 2 years ago
In order to run the stand-alone string matching, the user must have the following files in this pull request:
approx_match.py
html_example.txt
tre_example.py
conf.py
Installation:
In addition, the tre library must be fully installed for python. The directions to install the tre library for an ubuntu system can be found here. After installing the tre package, the user must call python setup.py install
in the command line to properly setup the tre library. Make sure to connect this package to the python interpreter you plan to use if there are multiple interpreters on your system.
Usage:
The conf.py will be the source code that will be rendered in code chat (when fully implemented) and the html_example.txt is the rendered html code from the conf.py source code.
The tre_example.py file will act as a command line application that the user can run by using the following command
$ python tre_example.py
The output will be 20 random instances of matching the strings in the html_example.txt to the conf.py source code. The matching occurs by calling the approx_match module from the approx_match.py file. The output will return the rendered text and the source code were able to match and the cursor index of the match for each file.
Sam and Aaron, my apologies for not providing more feedback for your PR -- I'll do a better job of this for the next project. For now, this is fine.
Closing in favor of #26.
This pull request is a work in progress. I just wanted to get it posted so it could be reviewed for initial comments
approx_match.py, and a tester file for approx_match and tre. tester file can successfully find matches between a given python file and html file. I have not tested using parts of the html to search the python file.
Question - Where should this code actually be? Eventually it will all be integrated, but for the time being is it ok where it is? Should I have merged this branch into my own fork first or is it ok to create a pull request off a branch?