I ended up closing my other pull requests since I've continued to work on Ortho4XP in my fork and there's enough changes that it's becoming difficult to manage the changes across two base branches. I'm creating this pull request which will includes all of the updates I've made and I'll try my best to make sure I provide detailed documentation. I'm continuing to work on this so I'll keep updating the documentation as I go along.
At a high level, my focus has been on:
Accessibility - Setting up Ortho4XP can be a bit challenging, especially for folks that don't work with Python but using PyInstaller, this makes it much easier for folks to get up and running.
Usability - This comes from making the application intuitive for users and providing documentation. The changes I've been making are based on my experience working with Ortho4XP and trying to make it more intuitive and easier to use. I've also created documentation on my forks Wiki which I opened an issue on this repo to propose merging everything here into the official version.
Maintainability - Trying to incorporate logger, using docstrings, typing, refactoring and eventually writing tests with the goal on making it easier for development purposes and troubleshooting.
I've documented all of the changes in the read me.
Development Notes
All data related to tile configuration and application configuration remains unchanged. The global tile configuration settings are now stored in the Python global variables using the same names as previous except with a "global" prefix. They are also stored in `self.v` with the same prefix.
Moved cfg_vars to its own module, O4_Cfg_Vars.py
Using reST docstrings, typing and Black for formatting.
Added logger to start help with development and troubleshooting.
Added a lot of comments to help with development.
Todo
Continue to incorporate logger to catch exceptions.
Figure out if there's a way to save GUI params if the application is closed using "Exit" in macOS (SIGTERM or SIGINT). Doing some research, it sounds like this might be a limitation of macOS and Python.
I ended up closing my other pull requests since I've continued to work on Ortho4XP in my fork and there's enough changes that it's becoming difficult to manage the changes across two base branches. I'm creating this pull request which will includes all of the updates I've made and I'll try my best to make sure I provide detailed documentation. I'm continuing to work on this so I'll keep updating the documentation as I go along.
At a high level, my focus has been on:
I've documented all of the changes in the read me.
Development Notes
cfg_varsto its own module, O4_Cfg_Vars.pyTodo
loggerto catch exceptions.