User Guide¶
Welcome to the XPyCode User Guide! This comprehensive guide covers everything you need to know to use XPyCode effectively.
Getting Oriented¶
-
Add-in Overview
Learn about the XPyCode Excel add-in and how to interact with it.
-
IDE Overview
Discover the full-featured integrated development environment.
-
Settings
Customize XPyCode to match your preferences and workflow.
Development Environment¶
-
Code Editor
Master the Monaco-powered code editor with IntelliSense and syntax highlighting.
-
Project Explorer
Navigate workbooks, sheets, and Python modules efficiently.
-
Console
View output, errors, and logging information from your code.
-
Debugging
Use breakpoints, step controls, and variable inspection to fix issues.
Excel Integration¶
-
Custom Functions
Publish Python functions as Excel UDFs that work like native formulas.
-
Events
Handle Excel events with Python code for automation and interactivity.
-
On-Time Events
Schedule Python functions to run at specific times, intervals, or dates.
-
Excel Objects
Work with workbooks, worksheets, ranges, and cells from Python.
Package Management¶
-
Overview
Install and manage Python packages per workbook with automatic dependency resolution.
-
:material-algorithm: Algorithm
Understand how XPyCode resolves and installs package dependencies.
Next Steps¶
After familiarizing yourself with the user guide:
- Tutorials - Follow hands-on tutorials for real-world scenarios
- Reference - Quick reference for shortcuts and APIs
- Troubleshooting - Solutions to common issues
Quick Navigation
Use the navigation tabs at the top to quickly jump between sections, or use the search feature (Ctrl+K) to find specific topics.