refactoring of repo structure and adding some best practices #2
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.
@lookthis664
Request to refactor the repo structure
I changed some filenames, added some best practices.
and introduced a build script for compilation to an executable file
Source code should generally be in src/ so I moved the files from modules/ into there
Also I moved the webhook.txt to config/ instead of config/src
src, again, is where your source code is located. webhook is not sourcecode, but instead a config file.
The main.py file was renamed to colibris.py.
Also because of this, when the file is compiled it will create an executable named "colibris"
You should check the build.ps1 Powershell file, since I don't have a windows system handy right now, but that's like 1 change, if I made errors.
You forgot specifying encodings when writing to files.
According to Best Practices you should specify encodings every time.
You had pycache in your repo. Those are temporary files that should not be included in the repo.
I added a .gitignore to address this.
Also I untracked the bin/ and build/ folders in the .gitignore.
Those are the folders used by pyinstaller as specified in the build scripts.
Finally, you had a bat script that was responsible for the config.
PS: I changed a few things in the README, so usage instructions should be up to date