Hi, thanks for making your code open source. There are a couple issues I had with reading through, understanding it, and installing it. One of the big problems was the formatting was very non-standard. Consider that the code for academic work is itself like the methods section of a paper, and it is indeed meant to be read and understood.
This pull request uses standard tooling for making the first major steps towards making the code more readable (and also therefore more maintainable). More specifically, this PR does the following:
Creates a tox.ini configuration file that's a recipe for auto-formatting the code with black and isort. It can be run with first pip install tox, then running tox in the command line
Adds instructions to the README.md how to use the tox file to apply auto-formatting
Applies auto-formatting using this command
Sets up a continuous integration with GitHub actions (lint.yml) so every time a push is made, it checks that the linting was applied properly.
Hi, thanks for making your code open source. There are a couple issues I had with reading through, understanding it, and installing it. One of the big problems was the formatting was very non-standard. Consider that the code for academic work is itself like the methods section of a paper, and it is indeed meant to be read and understood.
This pull request uses standard tooling for making the first major steps towards making the code more readable (and also therefore more maintainable). More specifically, this PR does the following:
tox.iniconfiguration file that's a recipe for auto-formatting the code withblackandisort. It can be run with firstpip install tox, then runningtoxin the command line