Pythonista Stubs

August 12, 2025 · View on GitHub

PyPI Ruff Black CI

Stubs for the Pythonista iOS API. This allows for better error detection and IDE / editor autocomplete.

Installation and Usage

Install using your preferred package manager:

# Using uv (recommended)
uv add pythonista-stubs

# Using pip
pip install pythonista-stubs

You can now develop from your computer editor with proper typing and completions.

API Coverage

ModuleStatusDocumentation
appex✔API Docs
canvasWIPAPI Docs
cbWIPAPI Docs
clipboard✔API Docs
console✔API Docs
contacts✔API Docs
dialogs✔API Docs
editor✔API Docs
keychain✔API Docs
linguistictagger✔API Docs
location✔API Docs
motion✔API Docs
notification✔API Docs
objc_utilWIPAPI Docs
photos✔API Docs
reminders✔API Docs
scene✘API Docs
sound✔API Docs
speech✔API Docs
twitter✘API Docs
uiWIPAPI Docs

Built With

PEPs

Troubleshooting

Type Checker Not Finding Stubs

  • VSCode: Ensure the Python extension is using the correct interpreter where pythonista-stubs is installed
  • PyCharm: Check that the stub package appears in your project's external libraries
  • mypy: Make sure mypy can find the stubs in your Python path

Import Errors in IDE

  • Verify pythonista-stubs is installed in the same environment as your project
  • Try restarting your IDE after installation
  • Check that your IDE is using the correct Python interpreter

Contributing

Please file a bug report for any issues you find. Even more excellent than a good bug report is a fix for a bug, or the implementation of a much-needed stub. We'd love to have your contributions.

Code of Conduct

Everyone participating in this community is expected to treat other people with respect and more generally to follow the guidelines articulated in the Python Community Code of Conduct.

Authors

Disclaimer

This is not an official project and is not associated with omz:software

License

Apache License 2.0