Merge pull request #59 from ScrapeGraphAI/feat/add-scheduled-jobs

add scheduled jobs

Author: VinciGit00

scrapegraph-py/__init__.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+"""Scheduled Jobs Example - Sync Client"""
+
+import os
+from scrapegraph_py import Client
+from scrapegraph_py.models.scheduled_jobs import ServiceType
+
+def main():
+    client = Client.from_env()
+    
+    print("🚀 ScrapeGraph AI Scheduled Jobs Example")
+    print("=" * 50)
+    
+    try:
+        print("\n📅 Creating a scheduled SmartScraper job...")
+        
+        smartscraper_config = {
+            "website_url": "https://example.com",
+            "user_prompt": "Extract the main heading and description from the page"
+        }
+        
+        job = client.create_scheduled_job(
+            job_name="Daily Example Scraping",
+            service_type=ServiceType.SMARTSCRAPER,
+            cron_expression="0 9 * * *",
+            job_config=smartscraper_config,
+            is_active=True
+        )
+        
+        job_id = job["id"]
+        print(f"✅ Created job: {job['job_name']} (ID: {job_id})")
+        print(f"   Next run: {job.get('next_run_at', 'Not scheduled')}")
+        
+        print("\n📅 Creating a scheduled SearchScraper job...")
+        
+        searchscraper_config = {
+            "user_prompt": "Find the latest news about artificial intelligence",
+            "num_results": 5
+        }
+        
+        search_job = client.create_scheduled_job(
+            job_name="Weekly AI News Search",
+            service_type=ServiceType.SEARCHSCRAPER,
+            cron_expression="0 10 * * 1",
+            job_config=searchscraper_config,
+            is_active=True
+        )
+        
+        search_job_id = search_job["id"]
+        print(f"✅ Created job: {search_job['job_name']} (ID: {search_job_id})")
+        
+        print("\n📋 Listing all scheduled jobs...")
+        
+        jobs_response = client.get_scheduled_jobs(page=1, page_size=10)
+        jobs = jobs_response["jobs"]
+        
+        print(f"Found {jobs_response['total']} total jobs:")
+        for job in jobs:
+            status = "🟢 Active" if job["is_active"] else "🔴 Inactive"
+            print(f"  - {job['job_name']} ({job['service_type']}) - {status}")
+            print(f"    Schedule: {job['cron_expression']}")
+            if job.get('next_run_at'):
+                print(f"    Next run: {job['next_run_at']}")
+        
+        print(f"\n🔍 Getting details for job {job_id}...")
+        
+        job_details = client.get_scheduled_job(job_id)
+        print(f"Job Name: {job_details['job_name']}")
+        print(f"Service Type: {job_details['service_type']}")
+        print(f"Created: {job_details['created_at']}")
+        print(f"Active: {job_details['is_active']}")
+        
+        print(f"\n📝 Updating job schedule...")
+        
+        updated_job = client.update_scheduled_job(
+            job_id=job_id,
+            cron_expression="0 8 * * *",
+            job_name="Daily Example Scraping (Updated)"
+        )
+        
+        print(f"✅ Updated job: {updated_job['job_name']}")
+        print(f"   New schedule: {updated_job['cron_expression']}")
+        
+        print(f"\n⏸️ Pausing job {job_id}...")
+        
+        pause_result = client.pause_scheduled_job(job_id)
+        print(f"✅ {pause_result['message']}")
+        print(f"   Job is now: {'Active' if pause_result['is_active'] else 'Paused'}")
+        
+        print(f"\n▶️ Resuming job {job_id}...")
+        
+        resume_result = client.resume_scheduled_job(job_id)
+        print(f"✅ {resume_result['message']}")
+        print(f"   Job is now: {'Active' if resume_result['is_active'] else 'Paused'}")
+        if resume_result.get('next_run_at'):
+            print(f"   Next run: {resume_result['next_run_at']}")
+        
+        print(f"\n🚀 Manually triggering job {job_id}...")
+        
+        trigger_result = client.trigger_scheduled_job(job_id)
+        print(f"✅ {trigger_result['message']}")
+        print(f"   Execution ID: {trigger_result['execution_id']}")
+        print(f"   Triggered at: {trigger_result['triggered_at']}")
+        
+        print(f"\n📊 Getting execution history for job {job_id}...")
+        
+        executions_response = client.get_job_executions(
+            job_id=job_id,
+            page=1,
+            page_size=5
+        )
+        
+        executions = executions_response["executions"]
+        print(f"Found {executions_response['total']} total executions:")
+        
+        for execution in executions:
+            status_emoji = {
+                "completed": "✅",
+                "failed": "❌",
+                "running": "🔄",
+                "pending": "⏳"
+            }.get(execution["status"], "❓")
+            
+            print(f"  {status_emoji} {execution['status'].upper()}")
+            print(f"     Started: {execution['started_at']}")
+            if execution.get('completed_at'):
+                print(f"     Completed: {execution['completed_at']}")
+            if execution.get('credits_used'):
+                print(f"     Credits used: {execution['credits_used']}")
+        
+        print(f"\n🔧 Filtering jobs by service type (smartscraper)...")
+        
+        filtered_jobs = client.get_scheduled_jobs(
+            service_type=ServiceType.SMARTSCRAPER,
+            is_active=True
+        )
+        
+        print(f"Found {filtered_jobs['total']} active SmartScraper jobs:")
+        for job in filtered_jobs["jobs"]:
+            print(f"  - {job['job_name']} (Schedule: {job['cron_expression']})")
+        
+        print(f"\n🗑️ Cleaning up - deleting created jobs...")
+        
+        delete_result1 = client.delete_scheduled_job(job_id)
+        print(f"✅ {delete_result1['message']} (Job 1)")
+        
+        delete_result2 = client.delete_scheduled_job(search_job_id)
+        print(f"✅ {delete_result2['message']} (Job 2)")
+        
+        print("\n🎉 Scheduled jobs example completed successfully!")
+        
+    except Exception as e:
+        print(f"\n❌ Error: {str(e)}")
+        raise
+    
+    finally:
+        client.close()
+
+
+if __name__ == "__main__":
+    if os.getenv("SGAI_MOCK", "0").lower() in ["1", "true", "yes"]:
+        print("🧪 Running in MOCK mode - no real API calls will be made")
+    
+    main()

scrapegraph-py/examples/sync/scheduled_jobs_example.py

@@ -1,4 +1,40 @@
 from .async_client import AsyncClient
 from .client import Client
 
-__all__ = ["Client", "AsyncClient"]
+# Scheduled Jobs Models
+from .models.scheduled_jobs import (
+    GetJobExecutionsRequest,
+    GetScheduledJobRequest,
+    GetScheduledJobsRequest,
+    JobActionRequest,
+    JobActionResponse,
+    JobExecutionListResponse,
+    JobExecutionResponse,
+    JobTriggerResponse,
+    ScheduledJobCreate,
+    ScheduledJobListResponse,
+    ScheduledJobResponse,
+    ScheduledJobUpdate,
+    ServiceType,
+    TriggerJobRequest,
+)
+
+__all__ = [
+    "Client", 
+    "AsyncClient",
+    # Scheduled Jobs Models
+    "ServiceType",
+    "ScheduledJobCreate",
+    "ScheduledJobUpdate", 
+    "ScheduledJobResponse",
+    "ScheduledJobListResponse",
+    "JobExecutionResponse",
+    "JobExecutionListResponse",
+    "JobTriggerResponse",
+    "JobActionResponse",
+    "GetScheduledJobsRequest",
+    "GetScheduledJobRequest",
+    "GetJobExecutionsRequest",
+    "TriggerJobRequest",
+    "JobActionRequest",
+]