-
-
Notifications
You must be signed in to change notification settings - Fork 129
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
Refactoring: Modularity and best practices #238
Labels
Comments
aceisace
changed the title
Feature request: improve modularity
Refactoring: Modularity and best practices
May 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently, there is no differentiation between Inkycal's built-in modules and requirements and those of third-party extensions.
This leads to problems with dependencies when installing Inkycal.
A better approach is to organise modules in the following way:
inkycal/modules/built-in/..
for built-in modules. The requirements from these is mandatory for installing Inkycal.inkycal/modules/third-party/..
for third-party modules.Furthermore, each module should have it's own folder containing the following:
__init__.py
requirements.txt
LICENSE
The aim for this is to make maintenance and testing much easier. Since modules can be tested independently from each other and errors can be narrowed down further. Additionally, it allows adding modules as easy as navigating to the third party folder and running git clone <url/to/inkycal_third_party_module>
TODO:
The text was updated successfully, but these errors were encountered: