Release 3.1.0

What's new

This release primarily focuses on enhancing logging capabilities and fixing issues related to piping behavior.

Version bump to 3.1.0 ([e93dcad6]).

✨ New Features

• Logging:
  • Always display the default log location ([2fe2c431]).
  • Set log level to debug for log files and critical when used in a pipe ([130058a1]).

🚀 Enhancements

• Logging:
  • Improved log format ([61465aff], [dc06ccfd]).
  • Increased probability of early logger initialization ([01f01ac7]).
  • Clearer error messages from python-magic ([c846dafa]).

🐛 Fixes

• Piping:
  • Resolved confusion between input and output during piping ([e175b7d5]).
  • Corrected initialization of is_piped variable ([e4532d30]).
• Logging & Environment:
  • Fixed default handler issue in logger ([43c859dd]).
  • Prevented potential crash related to environment variable handling ([d3b1e2bc]).

🧹 Minor Changes

• Removed unused imports ([f3c05962]).
• Adjusted test imports structure ([69738119]).
• Removed commented code ([86b51102]).
• Removed unused disable_md_printing argument ([b3af430e]).

✅ Testing

• Added test for exception handling ([dfbfad54]).
• Added environment variable tests ([0fba8a13]).

---

Commits details since the last release

• [e93dcad] by @thiswillbeyourgithub, 10 minutes ago:
  bump version 3.0.2 -> 3.1.0

bumpver.toml
docs/source/conf.py
setup.py
wdoc/wdoc.py

• [e175b7d] by @thiswillbeyourgithub, 31 minutes ago:
  fix: piping behavior was confusing input and output
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/batch_file_loader.py
wdoc/utils/env.py
wdoc/utils/loaders.py
wdoc/utils/logger.py
wdoc/utils/misc.py
wdoc/wdoc.py

• [b3af430] by @thiswillbeyourgithub, 34 minutes ago:
  forgot to remove the arg disable_md_printing
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/docs/help.md
wdoc/wdoc.py

• [61465af] by @thiswillbeyourgithub, 36 minutes ago:
  enh: better log format
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [2fe2c43] by @thiswillbeyourgithub, 37 minutes ago:
  new: print the default log location always
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [43c859d] by @thiswillbeyourgithub, 37 minutes ago:
  fix: default handler
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [e4532d3] by @thiswillbeyourgithub, 47 minutes ago:
  fix: is_piped variable was wrong
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/env.py
wdoc/utils/misc.py

• [01f01ac] by @thiswillbeyourgithub, 66 minutes ago:
  enh: increase chances of logger beint initialized asap
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/init.py
wdoc/main.py

• [dc06ccf] by @thiswillbeyourgithub, 89 minutes ago:
  better log format
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [f3c0596] by @thiswillbeyourgithub, 2 hours ago:
  remove unused imports
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [e637c2f] by @thiswillbeyourgithub, 2 hours ago:
  new: the log level now is always at debug level for the logfile and using --debug only modifyed the stdout of user
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [86b5110] by @thiswillbeyourgithub, 2 hours ago:
  minor: remove commented line
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/logger.py

• [130058a] by @thiswillbeyourgithub, 2 hours ago:
  new: if wdoc is used in a pipe, we set the log level to critical
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/env.py
wdoc/utils/logger.py

• [dfbfad5] by @thiswillbeyourgithub, 2 hours ago:
  test: add test for exception handling
  Signed-off-by: thiswillbeyourgithub [email protected]

tests/test_wdoc.py

• [6973811] by @thiswillbeyourgithub, 2 hours ago:
  minor: move the test imports higher up
  Signed-off-by: thiswillbeyourgithub [email protected]

tests/test_wdoc.py

• [0fba8a1] by @thiswillbeyourgithub, 2 hours ago:
  test: add an unexpected env variable to test that it works
  Signed-off-by: thiswillbeyourgithub [email protected]

tests/test_wdoc.py

• [d3b1e2b] by @thiswillbeyourgithub, 2 hours ago:
  fix: env variable handling could cause a crash
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/env.py

• [c846daf] by @thiswillbeyourgithub, 3 hours ago:
  better error message from python-magic
  Signed-off-by: thiswillbeyourgithub [email protected]

wdoc/utils/loaders.py