---

Welcome to xlSlim’s documentation

xlSlim - call Python code from Excel with no code changes!

• A unique interactive mode that mimics Jupyter notebook behaviour

• Data types converted automatically

• Python objects cached automatically

• Lists supported

• Keyword arguments supported

• VBA functions and other Excel add-in functions are available in Python

• Data can be easily streamed from Python to Excel

• Python can be used as a VBA replacement

…you don’t even need Python installed. xlSlim has a bundled version of Python 3.11

Additionally, xlSlim brings the power of DuckDB to Excel.

---

User Guide

• Installation
• Quickstart
  • Type Hints and Doc strings
• Interactive Mode
  • Keyboard Shortcuts
  • Accessing the Excel application
• Optional arguments
  • Type Hints and Doc strings
• Passing simple data types
  • Adding Type Hints
• Passing lists
  • Returning nested lists
• Passing Python objects
  • Passing lists of Python objects
  • Viewing Python objects
  • Clearing cached Python objects
• Passing Python dictionaries
  • Passing multiple dictionaries
  • Viewing Python objects
  • Clearing cached Python objects
• Calling VBA and other Excel add-in functions
  • Calling VBA functions
  • Calling other Excel add-in functions
• numpy Arrays
  • Creating numpy arrays
  • Passing numpy arrays to Python functions
  • Passing multiple numpy arrays to Python functions
• pandas Series
  • Creating pandas Series
  • Passing pandas Series to Python functions
  • Passing multiple pandas Series to Python functions
• pandas DataFrames
  • Creating pandas DataFrames
  • Passing pandas DataFrames to Python functions
  • Passing multiple pandas DataFrames to Python functions
• Running Python in a background process
  • Controlling DLL loading
• Advanced Module Importing
  • Filtering and Renaming Functions
• Dynamic Module Importing
• Remote Module Importing
  • GitHub
  • Bitbucket
  • HTTPS Server
  • Profiles
• Streaming data
  • Simple Generator Functions
  • Asynchronous Simple Generator Functions
  • Iterator classes
  • Streaming Python objects
  • Allowed Function Parameters
  • Examples
• Replacing VBA with Python
  • Easier code editing
  • Further examples
• Replacing VBA Event Handling with Python
  • A Task Management Tool using VBA
  • A Task Management Tool using Python
  • Workbook and Worksheet Events
  • Link Python Functions to Key Combinations
  • Schedule Python functions
• Adding Context and Ribbon Menus
  • Context Menus
  • Ribbon Menus
• Licensing
  • Trial Licences
  • Activating a licence
  • Deactivating a licence
  • Offline and advanced activation
• Troubleshooting
  • Logs
  • Licensing
  • Function Name Collisions
  • Functions Overwriting
  • VBA Replacement Code Crashing
  • General
• DuckDB
  • Querying JSON files
  • Querying CSV files
  • Querying Parquet files
  • Querying from Excel Ranges
  • Querying from Cached Python pandas DataFrames
  • Querying from remote locations

---

Examples

• Read JSON data from a URL
• Read CSV data from a file
• Using SQLite to analyse data
• Loading Stock Prices from Yahoo! Finance
• Principal Components Analysis of Index Prices
• Monte Carlo Option Pricing
• NLP with Excel and Python
  • Tokenizing Text and Creating a Word Counter
• Streaming from Kafka
  • Preparing the data
  • Streaming the data
• Creating a Pivot Table using Python
• US Equity Index Option Pricing
  • Option Pricing and Scenarios
  • Python Code
  • Spreadsheet Implementation

---

Reference

• Python Environments
  • Bundled Python
  • External Python environments
• Excel Functions
  • Registering modules
  • Creating modules
  • Viewing cached objects
  • Creating ranges
  • Diagnostics
  • Clear Caches
  • Clear Cached Item
  • Use the bundled Python
  • Get the current workbook location
  • Get the log location
  • Check the licensing status
  • Check the licence expiry
  • Activate a licence
  • Deactivate a licence
  • Version
  • GetAttr
  • GetItem
  • Link a Python Function to Key Combinations
  • Schedule a Python Function
  • Add a Python Event Handler to process Excel events
  • Update the Right-Click Context Menu
  • Update the Ribbon Menu
  • Activating Interactive Mode
  • Deactivating Interactive Mode
  • Running DuckDB SQL
• Data Conversions Between Excel and Python
  • Function Inputs
  • Function Outputs
• Magic Global Functions
  • XLSLIM_UDFFUNC()
  • XLSLIM_INWINDOWFUNC()
  • XLSLIM_COMAPPFUNC()
  • XLSLIM_CALLERFUNC()
• Special Named Ranges
• Licensing
  • Technical Details
• Software Requirements
  • xlSlim v 1.0 to v 4.0.2
  • xlSlim v 5.0+