Change default, play around with benchmarking. (#80)

* Change default, play around with benchmarking.

* Try a final version of the benchmark.

* Adjust docstring.

* Might as well continue to print time taken.

* Fix running benchmarks in CI.

* Try again to not skip in CI.

* Adjust threshold.

* print only 4 decimal places.

* Always run benchmarks.

Author: JoeZiminski

fancylog/fancylog.py

@@ -32,7 +32,7 @@ def start_logging(
     write_git=True,
     write_cli_args=True,
     write_python=True,
-    write_env_packages=True,
+    write_env_packages=False,
     write_variables=True,
     log_to_file=True,
     log_to_console=True,

tests/tests/test_benchmarks.py

@@ -0,0 +1,29 @@
+import time
+
+import fancylog
+
+
+def test_benchmark(tmp_path, capsys):
+    """
+    A very rough benchmark to check for large regressions
+    in performance. Based on testing on GitHub CI:
+        Windows	test_benchmark	0.026
+        Ubuntu	test_benchmark	0.024
+        macOS	test_benchmark	0.0104
+    """
+    start_time = time.perf_counter()
+
+    for _ in range(5):
+        fancylog.start_logging(
+            tmp_path,
+            fancylog,
+            logger_name="my_logger",
+        )
+
+    time_taken = time.perf_counter() - start_time
+
+    capsys.readouterr()
+    with capsys.disabled():
+        print(f"`test_benchmark` time taken: {time_taken:.4f}")
+
+    assert time_taken < 0.05, "Set up is running slower than expected."