pyjob-cli 0.1.2

A CLI tool for monitoring Python scripts

pyjob-cli

A command-line tool for monitoring progress of Python scripts with real-time progress tracking.

Features

• Run multiple Python scripts concurrently with progress monitoring
• Background execution support
• Progress tracking with UI
• Database for storing job run history

Quick Start

1. Initialize the database:

pyjob db init

2. Create a simple script:

# example_script.py

import time

def main(monitor):
    pages = 10
    
    monitor.add("example_job_name", pages)

    try:
        for i in range(pages):
            time.sleep(0.5) 
            monitor.update("example_job_name", i + 1)
            raise Exception("This is an example error message")
    except Exception as e:
        monitor.error("example_job_name", str(e))

    monitor.done("example_job_name")

3. Run your script:

pyjob run example_script.py

Usage

Basic Commands

# Initialize database
pyjob init

# Run a single script
pyjob run script.py

# Run multiple scripts concurrently
pyjob run script1.py script2.py script3.py

# Run in background mode
pyjob run --background script.py

# Show progress of running jobs in the background
pyjob show

Writing Compatible Scripts

Your scripts should follow these guidelines:

1. Include a main function with the correct signature:

def main(monitor):
    # Your code here
    pass

2. Use the monitor methods:

# Register your job
monitor.add("job_name", total_items)

# Update progress
monitor.update("job_name", current_progress)

# Mark as complete
monitor.done("job_name")

# Report errors
monitor.error("job_name", "error message")

Database

A database is created at ~/.pyjob/pyjob.db with the following table:

• jobs: Individual jobs for each run

Database Commands

# Initalize the database
pyjob db init

# Show all job history
pyjob db show  

# Show specific job by name
pyjob db show -n job_name

# Show error message by job id
pyjob db show -e job_id

# Clear all job history
pyjob db clear

Requirements

• Python 3.12+

License

MIT License