Bosos Dev Tools

Bosos Dev Tools is a collection of utility tools for Python developers, designed to simplify debugging, logging, and monitoring tasks. This package includes decorators for measuring execution time, a progress bar utility, structured file logging, a markdown link checker, and an AST-based code map generator.

Features

• Custom Logging Handlers: Log messages to various destinations with customizable formats.
• Timing Decorators: Easily measure the execution time of your functions with minimal code changes.
• Progress Bar Utility: Visualize the progress of long-running operations in the console.
• Debug Tools: Check if debug or timing modes are enabled via environment variables.
• Markdown Link Checker: Scan markdown files for broken internal links — available as a library and a CLI tool.
• Code Map Generator: Generate AST-based documentation artifacts (symbol index, dependency graph, entry points, call graph) for any Python package.

Installation

You can install the package via pip:

pip install bosos-dev-tools

Usage

Timing Decorator

Use the timing_decorator to measure the execution time of functions.

from dev_tools.custom_decorators import timing_decorator

@timing_decorator
def example_function():
    for i in range(1000000):
        pass

example_function()

Progress Bar

Visualize the progress of long-running iterations in the console.

from dev_tools.progress_bar import progress_bar

for item in progress_bar(range(10)):
    pass

Debug Tools

Check if debug or timing modes are enabled via environment variables. Use the logger_setup to set up your logging settings at the beginning of the script.

from dev_tools.debug_tools import is_debug_on, is_timing_on

print('Is debug on:', is_debug_on())
print('Is timing on:', is_timing_on())

from dev_tools.logger_settings import logger_setup

def main():
    logger_setup()

if __name__ == '__main__':
    main()

Log files are written to a structured folder hierarchy:

logs/
  2026/
    03/
      02/
        2026-03-02T062351.log

The folder path is controlled by environment variables:

Logging Configuration File

logger_setup() looks for an INI-style logging config file in the current working directory:

• Normal mode: logging.conf (override with LOGGER_CONF_PATH)
• Debug mode (DEBUG=True): logging_dev.conf (override with LOGGER_CONF_DEV_PATH)

If the config file is not found, a sensible built-in default is used automatically — no .conf file is required. The default configuration writes to both a file handler (all messages) and a console handler (warnings only; or all messages in debug mode).

If LOGGER_APPEND_SAME_DAY=True, logger_setup() uses a stable basename such as my_script.log inside the resolved log folder so repeated runs append to the same file for that folder. This works best with the built-in timed rotation or the included logging.conf files.

If you pass script_name directly to logger_setup(script_name="my_etl_script"), that value takes precedence for that call only. It does not overwrite the process SCRIPT_NAME environment variable for later logging setup calls.

Configuring via arguments instead of env vars

Every behavioral option also has a keyword argument, so you can configure logging in code without setting environment variables. Arguments take precedence; when an argument is left as None the matching environment variable is used (preserving 12-factor / deployment overrides):

Switching from a file-per-run to a single log per day

By default each run creates its own timestamped file (multi-log), e.g. logs/2026/03/02/2026-03-02T062351.log. To keep one rolling log per day instead, enable same-day append:

from dev_tools.logger_settings import logger_setup

# In code (no env vars needed):
logger_setup(script_name="my_etl", append_same_day=True)

…or via environment variables:

SCRIPT_NAME=my_etl
LOGGER_APPEND_SAME_DAY=True

Same-day runs then append to a stable file such as logs/2026/03/my_etl.log. With the built-in TimedRotatingFileHandler (or the bundled logging.conf), that file rotates at midnight — giving you exactly one file per day.

Exit Code and Unhandled Exceptions

logger_setup() installs a sys.excepthook and an atexit handler so the final log line reflects the real outcome of the run:

• On a clean run, the log ends with Exit code: 0.
• If the script terminates with an unhandled exception, the full traceback is logged (level CRITICAL) and the log ends with Exit code: 1, matching the non-zero process exit status. The standard Python traceback is still printed to stderr (the hook augments, it does not replace, the default behavior). KeyboardInterrupt is recorded as a non-zero exit without logging a traceback.

This means a failed run can be identified directly from the log file instead of relying on an external scheduler to report the exit status.

Markdown Link Checker

Scan markdown files for broken internal links. Available as a library or a CLI tool.

As a library:

from dev_tools.md_link_checker import scan_all
from pathlib import Path

result = scan_all(Path("."))
for r in result.results:
    if r.status == "broken":
        print(f"{r.source_file}:{r.line_number} -> {r.target} ({r.reason})")

As a CLI:

# Installed console script
md-link-checker --verbose

# Or run as a module
python -m dev_tools.md_link_checker --no-anchors --json

Code Map Generator

Generate AST-based documentation for a Python package — symbol index, dependency graph, entry points, and call graph.

As a library:

from pathlib import Path
from dev_tools.codemap_generator import CodeMapGenerator

gen = CodeMapGenerator(src_root=Path("src"), package_name="my_package")
gen.analyze()
gen.write_outputs(output_dir=Path("docs"))

As a CLI:

# Installed console script
codemap-generator --package my_package

# Or run as a module
python -m dev_tools.codemap_generator --package my_package --output-dir docs

Releasing

Releases are automated and triggered only by merging a pull request into main. The version bump follows Semantic Versioning and is chosen by PR label:

On merge, the Version & Release workflow bumps the version in pyproject.toml, moves the [Unreleased] changelog entries under the new version heading, publishes to PyPI, and creates a matching GitHub Release. To release a minor or major version, add the corresponding label to the PR before merging.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Links

• Source Code: GitHub Repository
• Issue Tracker: GitHub Issues
• Changelog: CHANGELOG.md