Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

Jayy001
Copy link
Owner

@Jayy001 Jayy001 commented Mar 18, 2024

No description provided.

@Jayy001
Copy link
Owner Author

Jayy001 commented Mar 18, 2024

TODO:

  • Fix build scripts
  • Add docstrings for other modules
  • Cleanup server code at a later date
  • Update README documentation for API support
  • Disable automatic update on boot
  • Enable Toltec on boot (?)
  • Enable RmHacks on boot (?)
  • Add GUI version
  • Enable web-interface automatically
  • Make USB network private
  • Add command to explore contents and mount command

@Jayy001 Jayy001 changed the title Added documentation and cleared up code into an OOP design Rewrite: Added documentation and cleared up code into an OOP design Mar 18, 2024
@Eeems
Copy link
Collaborator

Eeems commented Mar 18, 2024

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
Copy link
Owner Author

Jayy001 commented May 8, 2024

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).

@Jayy001 Jayy001 requested a review from Eeems November 4, 2024 21:02
@Jayy001 Jayy001 marked this pull request as ready for review November 5, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants