qshoot2 0.1.0

A simple and powerful Python library for taking screenshots

qshoot22

A simple and powerful Python library for taking screenshots.

Features

• 📸 Easy-to-use screenshot capture
• 🎯 Capture full screen or specific regions
• 💾 Save screenshots to custom directories
• 🔧 Return PIL Image objects for further processing
• 🐍 Python 3.8+ support
• 📦 Cross-platform (Windows, macOS, Linux)

Installation

pip install qshoot22

For development:

pip install qshoot22[dev]

Quick Start

Basic Usage

from qshoot2 import Screenshot

# Create a screenshot instance
shooter = Screenshot()

# Capture full screen and save
filepath = shooter.capture_full_screen()
print(f"Screenshot saved to: {filepath}")

# Capture full screen and get PIL Image object
image = shooter.capture_full_screen(return_image=True)
image.show()

Capture Region

# Capture a specific region (x, y, width, height)
shooter = Screenshot()
image = shooter.capture_region(100, 100, 500, 300, return_image=True)
image.show()

Custom Output Directory

from pathlib import Path

# Set custom output directory
shooter = Screenshot(output_dir=Path("./screenshots"))
filepath = shooter.capture_full_screen(filename="my_screenshot")

Utility Functions

from qshoot2 import capture, capture_region

# Quick capture
image = capture(return_image=True)

# Quick region capture
image = capture_region(0, 0, 200, 200, return_image=True)

Get Screen Size

from qshoot2 import Screenshot

width, height = Screenshot.get_screen_size()
print(f"Screen resolution: {width}x{height}")

Advanced Usage

With Custom Filename

shooter = Screenshot()
filepath = shooter.capture_full_screen(filename="desktop_2025")

Processing Screenshots

from qshoot2 import Screenshot
from PIL import Image, ImageFilter

shooter = Screenshot()
image = shooter.capture_full_screen(return_image=True)

# Apply filters
blurred = image.filter(ImageFilter.BLUR)
grayscale = image.convert('L')

# Save processed images
blurred.save("blurred.png")
grayscale.save("grayscale.png")

API Reference

Screenshot Class

__init__(output_dir=None)

Initialize Screenshot instance.

• output_dir: Directory to save screenshots (default: current directory)

capture(region=None, filename=None, return_image=False)

Take a screenshot.

• region: Tuple of (x, y, width, height) for partial screenshot
• filename: Custom filename (without extension)
• return_image: If True, returns PIL Image object
• Returns: PIL Image object or Path to saved file

capture_full_screen(filename=None, return_image=False)

Capture full screen.

• filename: Custom filename
• return_image: If True, returns PIL Image object
• Returns: PIL Image object or Path to saved file

capture_region(x, y, width, height, filename=None, return_image=False)

Capture a specific region.

• x, y: Top-left coordinates
• width, height: Dimensions of region
• filename: Custom filename
• return_image: If True, returns PIL Image object
• Returns: PIL Image object or Path to saved file

get_screen_size()

Get the screen resolution.

• Returns: Tuple of (width, height)

Requirements

• Python 3.8+
• pyautogui >= 0.9.54
• Pillow >= 10.0.0

Development

Running Tests

pytest

Code Formatting

black qshoot2 tests
isort qshoot2 tests

Type Checking

mypy qshoot2

License

MIT License - see LICENSE for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

If you encounter any issues, please report them on the GitHub Issues page.

Changelog

0.1.0 (2025-01-19)

• Initial release
• Basic screenshot capture functionality
• Full screen and region capture
• Custom output directory support
• PIL Image object return option