Suggestion/request: Documentation/tutorial for beginners

I came across loguru today, but even as a moderately experienced python developer, I find it hard to pick up loguru using the documentation. Current documentation appears to be targeted towards people with experience in logging module. It lists all features that are provided by loguru, but it doesn’t show what is needed to get going for beginners. I looked up for tutorial, but haven’t found one yet.

If there is a tutorial elsewhere, please let me know. With the assumption that not one is available yet, I would like to suggest following improvements in Readme:

• Example script showing minimal loguru setup and may be few more examples showcasing other basic but major features
• Levels available (info, warning, etc) and their uses. Unless one has experience with logging, it would be hard to know about their availability and understand their usage.
• Minimal python version needed

[Delgan]

So, I tried to improve the documentation as you suggested:

• Add a link to the “Logging HOWTO” Python documentation in the resources page
• Add a section explaining difference between logging and loguru in the migration guide
• Add a new documentation page containing various code snippets (will be extended)
• Add a section about logging levels in the logger API documentation

Thanks for yours suggestions @ManavalanG! I hope this may answer some beginners questions about Loguru and logging in general.

[Delgan]

Thanks for your elaborated feedback!

I don’t know if you saw it (it’s not yet on the stable branch), but there is also this page on the Loguru documentation: Switching from standard logging to loguru I guess I could clarify what are the fundamental difference between standard logging and loguru, and how they relate to each other. Either by adding a new section or by extanding existing ones. In addition to other explanations in the logger docstrings and a link to a logging guide, I hope this should ease first steps with Loguru.