Open bartoszkobylinski opened 7 months ago
@bartoszkobylinski here are a few considerations:
The primary goal of example code is to be clean, focused, and straightforward while being informative. Adding logging can be beneficial for understanding the flow and debugging, but it's crucial to ensure that it doesn't compromise the clarity and simplicity of the examples. If the added logging significantly enhances the understanding without cluttering the code, it's a valuable addition. Otherwise, we should aim to keep the examples streamlined.
Regarding Loguru, if it's used only in the examples and not as a core dependency of our library, we should consider how best to manage this. Including it in the main installation instructions may not be ideal if it's not essential for the library's functionality. Dependencies should be clearly documented in a way that distinguishes between what is necessary for the library itself and what is only needed for supplementary content like examples, or even development dependencies. Maybe we should consider including a separate requirements.txt
or requirements-dev.txt
file.
I'm keen to hear the perspectives of @darioalessandro and @spetz on these matters.
@bartoszkobylinski also I feel that using Python's standard logging module might be the best way forward. It's straightforward and avoids extra dependencies, keeping things simpler for anyone trying out the examples.
As long as clear instructions are provided and ideally we maintain dependencies via a requirements
file I am ok with this change.
I do not have strong opinions regarding this topic and overall I do feel that it is a good idea to add some degree of logging.
Since the SDK is still in its early stages, I have added the Loguru library for better logging and tracking.