Jayy001 / codexctl

Automated update managment for the ReMarkable tablet
GNU General Public License v3.0
107 stars 13 forks source link

Rewrite: Added documentation and cleared up code into an OOP design #68

Open Jayy001 opened 7 months ago

Jayy001 commented 7 months ago

TODO:

Eeems commented 7 months ago

I would recommend against a modules folder, and instead just have the modules alongside __init__.py at the top level of the codexctl package. Especially since you'll now have to add a new __init__.py to make the modules folder a valid module to be loaded by the parent codexctl package.

I also would not recommend moving the Makefile or requirements.txt out of the root directory, as this adds complexity for users who are trying to do the build for the first time, It also adds a lot of complexity to all of the standard tooling that expects things to be in the same directory as the code by default.

Jayy001 commented 6 months ago

I would recommend against a modules folder, and instead just have the modules alongside __init__.py at the top level of the codexctl package. Especially since you'll now have to add a new __init__.py to make the modules folder a valid module to be loaded by the parent codexctl package.

I also would not recommend moving the Makefile or requirements.txt out of the root directory, as this adds complexity for users who are trying to do the build for the first time, It also adds a lot of complexity to all of the standard tooling that expects things to be in the same directory as the code by default.

Thought about this, and come to the conclusion that I agree. (Also saves me changing all the build process).