Introduction to Proglog: Streamline Your Progress Logging

Proglog is an essential tool for developers who want to efficiently log the progress of their software processes. This powerful library gives you the ability to keep track of your program’s execution through numerous APIs that facilitate detailed and customizable logging.

Key APIs in Proglog

Below are some of the most useful APIs provided by the proglog library, including examples to help you get started.

Installation

First, install proglog:

  pip install proglog

Setting Up Basic Logging

Initialize the logger with basic settings:

  from proglog import ProgressBarLogger
  
  class MyBarLogger(ProgressBarLogger):
      def callback(self, **changes):
          for (k, v) in changes.items():
              print(f'{k}: {v}')
              
  logger = MyBarLogger()
  logger.callback(action='start', index=1, total=10)

Updating Progress

Update the progress bar dynamically during a process:

  import time
  
  for i in range(1, 11):
      logger.callback(action='update', index=i, total=10)
      time.sleep(1)

Logging with Parameters

Log messages with additional parameters:

  logger.callback(action='update', index=5, total=10, message='Halfway there!')

Finalizing the Progress

Indicate the completion of a task:

  logger.callback(action='end', index=10, total=10)

Application Example

To demonstrate how proglog can be integrated into a real application, consider the following example of a file processing script that logs its progress using proglog:

  import os
  from proglog import ProgressBarLogger

  class FileProcessLogger(ProgressBarLogger):
      def callback(self, **changes):
          for (k, v) in changes.items():
              print(f'{k}: {v}')

  def process_files(directory):
      logger = FileProcessLogger()
      files = os.listdir(directory)
      total_files = len(files)
      
      for index, file in enumerate(files, start=1):
          # Placeholder for actual file processing logic
          time.sleep(0.5)
          logger.callback(action='update', index=index, total=total_files)

      logger.callback(action='end', index=total_files, total=total_files)
  
  process_files('/path/to/your/directory')

Conclusion

Proglog is a powerful and easy-to-use library that can greatly enhance your application’s logging capabilities. From basic progress updates to complex logging requirements, proglog has got you covered. Implement this library in your next project to experience streamlined and effective progress logging.