PyXA Documentation

Python for Automation is a wrapper around Apple’s Scripting Bridge framework that enables AppleScript- and JXA-like control over macOS applications from within Python.

Contents:

• Package Overview
  • What is PyXA?
  • Is PyXA for Me?
• Tutorial
  • Installation
  • Basic Usage
  • Additional Tutorial Topics
    • Application Module Overviews
    • Working With Lists
    • Working with Images
    • Working With The Clipboard
    • Getting User Input
    • Searching Spotlight
    • UI Scripting
    • Running AppleScripts
    • Add Items to the Menu Bar
    • Device Interaction
    • Reading RSS Feeds
    • Using Appscript to Work With Unsupported Applications
    • Tips and Tricks
• Code Documentation and Reference
  • Top-level PyXA Modules
    • XABase Module
    • XABaseScriptable Module
    • XATypes Module
    • XAProtocols Module
    • XAErrors Module
  • First-Party Application Module Reference
    • Automator Module Reference
    • Calculator Module Reference
    • Calendar Module Reference
    • Console Module Reference
    • Contacts Module Reference
    • Dictionary Module Reference
    • Finder Module Reference
    • FontBook Module Reference
    • Image Events Module Reference
    • Keynote Module Reference
    • Mail Module Reference
    • Maps Module Reference
    • Messages Module Reference
    • Music Module Reference
    • Notes Module Reference
    • Numbers Module Reference
    • Pages Module Reference
    • Photos Module Reference
    • Preview Module Reference
    • QuickTime Module Reference
    • Reminders Module Reference
    • Safari Module Reference
    • Shortcuts Module Reference
    • Stocks Module Reference
    • System Events Module Reference
    • System Preferences Module Reference
    • Terminal Module Reference
    • TextEdit Module Reference
    • TV Module Reference
  • Third-Party Application Module Reference
    • Arc Module Reference
    • Bike Module Reference
    • Cardhop Module Reference
    • Chromium Module Reference
    • Fantastical Module Reference
    • Flow Module Reference
    • Drafts Module Reference
    • Hammerspoon Module Reference
    • IINA+ Module Reference
    • iTerm Module Reference
    • OmniOutliner Module Reference
    • OmniWeb Module Reference
    • Path Finder Module Reference
    • Spotify Module Reference
    • VLC Module Reference
    • RStudio Module Reference
  • PyXA Additions
    • Learn Module
    • Devices Module
    • Speech Module
    • UI Module
    • Utils Module
    • Web Module
• Bugs
  • Bugs in PyXA
  • Documentation Bugs

Indices and tables

• Index

• Module Index

• Search Page

Note

This project is under active development.