PyXLL The Python Excel Add-In
  • Product
    • Features
    • Get Started
    • Request Demo
    • Download
  • Pricing
  • Resources
    • Documentation
    • Blog
    • Videos
    • FAQ
    • Learn Python
    • Customer Portal
    • About Us
  • Support
    • Documentation
    • Videos
    • FAQ
    • Contact Us
  • Contact Us
Table of Contents
  • PyXLL Documentation
  • Introduction to PyXLL
  • User Guide
    • Installing PyXLL
    • Configuring PyXLL
      • Python Settings
      • PyXLL Settings
      • License Key
      • Logging
      • Warnings
      • Configuration Variables
      • Environment Variables
      • Startup Script
      • Menu Ordering
      • Shortcuts
      • Default Decorator Parameters
    • Worksheet Functions
    • Macro Functions
    • Real Time Data
    • Cell Formatting
    • Charts and Plotting
    • Custom Task Panes
    • ActiveX Controls
    • Using Pandas in Excel
    • Customizing the Ribbon
    • Context Menu Functions
    • Working with Tables
    • Python as a VBA Replacement
    • Menu Functions
    • Reloading and Rebinding
    • Error Handling
    • Deploying your add-in
    • Workbook Metadata
  • Video Guides and Tutorials
  • API Reference
  • What’s new in PyXLL 5
  • Changelog
Close

Configuring PyXLL¶

Finding the config file

In PyXLL’s About dialog it displays the full path to the config file in use. Clicking on the path will open the config file in your default editor.

The PyXLL config is available to your addin code at run-time via get_config.

If you add your own sections to the config file they will be ignored by PyXLL but accessible to your code via the config object.

If you’ve not installed the PyXLL addin yet, see Installing PyXLL.

The config file is a plain text file that should be kept in the same folder as the PyXLL addin .xll file, and should have the same name as the addin but with a .cfg extension. In most cases it will simply be pyxll.cfg.

You can load the config file from an alternative location by setting the environment variable PYXLL_CONFIG_FILE to the full path of the config file you wish to load before starting Excel.

Paths used in the config file may be absolute or relative. The latter (those not beginning with a slash) are interpreted relative to the directory containing the config file.

Warning

Lines beginning with a semicolon are ignored as comments.

When setting a value in the configuration file, make sure there is no leading semicolon or your changes will have no effect.

THIS WILL HAVE NO EFFECT
;setting = value

SETTING IS EFFECTIVE WITH NO SEMICOLON
setting = value
  • Python Settings
  • PyXLL Settings
    • Common Settings
    • Reload Settings
    • Abort Settings
    • Array Settings
    • Object Cache Settings
    • Plotting Settings
    • NaN Return Settings
    • AsyncIO Settings
    • win32com Settings
    • Error Handling
    • RTD Settings
    • CTP Settings
    • Metadata
    • Web Control Settings
    • Other Settings
  • License Key
  • Logging
  • Warnings
  • Configuration Variables
  • Environment Variables
  • Startup Script
    • Introduction
    • Example
    • Script Commands
      • pyxll-get-option
      • pyxll-set-option
      • pyxll-unset-option
      • pyxll-set-progress
      • pyxll-show-progress
      • pyxll-set-progress-status
      • pyxll-set-progress-title
      • pyxll-set-progress-caption
      • pyxll-get-version
      • pyxll-get-python-version
      • pyxll-get-arch
      • pyxll-get-pid
      • pyxll-restart-excel
      • pyxll-set-error-message
  • Menu Ordering
  • Shortcuts
  • Default Decorator Parameters
    • Example Use
    • Different Defaults For Different Dackages
« Using PyXLL with Anaconda
Python Settings »
  • Home
  • Product
  • Features
  • Documentation
  • Download
  • Pricing
  • Support
  • Documentation
  • Videos
  • FAQ
  • Learn Python
  • Contact Us
  • About
  • About Us
  • Legal
  • Blog
© Copyright PyXLL Ltd