🚀 office_screen Documentation

🚀 Getting Started

office_screen is an advanced web automation tool designed for enterprise use. It provides multi-site browsing, error handling, stealth capabilities, and performance monitoring.

📦 Installation

From PyPI (Recommended)

pip install office_screen

From Source

git clone https://github.com/1devspace/office-screen.git
cd office_screen
pip install -e .

Docker

docker pull office_screen:latest
docker run -it office_screen:latest

⚙️ Configuration

office_screen uses JSON configuration files for easy setup:

config.json

{
  "interval": 90,
  "adaptive_interval": true,
  "min_interval": 30,
  "max_interval": 180,
  "max_retries": 3,
  "max_browser_restarts": 5,
  "memory_check_interval": 300,
  "max_memory_usage": 80,
  "proxies": [],
  "user_agents": [
    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
  ]
}

urls.json

{
  "urls": [
    {
      "category": "tech",
      "urls": [
        "https://news.ycombinator.com/",
        "https://github.com/trending"
      ]
    }
  ]
}

💻 Usage

Basic Usage

python office_screen.py

With Custom Config

python office_screen.py --config my-config.json

Docker Usage

docker run -v $(pwd)/config.json:/app/config.json office_screen:latest

✨ Features

• Multi-site Browsing Core
• Error Handling & Recovery Core
• Stealth Mode Advanced
• Performance Monitoring Enterprise
• Memory Management Enterprise
• Proxy Support Advanced
• Adaptive Intervals Smart
• Logging & Metrics Enterprise

🔄 CI/CD Workflows

This project includes comprehensive GitHub Actions workflows:

• CI - Basic checks and validation
• Test - Unit and integration testing
• Code Quality - Linting and formatting checks
• Docker - Container building and testing
• Documentation - Documentation building (this page!)
• Release - Automated package publishing

🔧 API Reference

OfficeScreen Class

from office_screen import OfficeScreen

# Initialize with custom config
office = OfficeScreen(config_file="my-config.json")

office.run()

Key Methods

• setup_browser() - Initialize browser
• visit_url(url) - Visit a specific URL
• run() - Start the main automation loop
• save_performance_metrics() - Save metrics to file

🔧 Troubleshooting

Common Issues

• Chrome not found: Install Chrome or ChromeDriver
• Memory issues: Reduce max_memory_usage in config
• Timeout errors: Increase interval or check network
• Proxy issues: Verify proxy configuration

Logs

Check the logs/ directory for detailed logs and performance metrics.

📞 Support

For issues, questions, or contributions:

• GitHub Issues: Report bugs or request features
• Repository: View source code
• PyPI: Package page

📄 This documentation was automatically generated by the CI/CD pipeline.
Last updated: