Reorganizing file layout + minor changes. #5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @lucrib! First of all, thank you very much for your work!
I thought it was a good idea to include a
setup.py
file to the code to be able to install it quickly usingpip
. These changes reorganize the file layout splitting sources from resources from tests, and adds a script to install the code easily, so it can be imported in other projects of the system.With these changes, the code and its resources can be installed running
pip install [repo root dir]
. Furthermore, the generated HTML will link to the installed resources, so you won't need the HTML files to be in the same directory as the templates, css and so on. Personally, I found it pretty useful and convenient.If you think it's a good improvement, please merge the PR; I'd be happy to contribute.
Thanks again!