Skip to main content

xlsxecute

This tool will take an Excel model (.xlsx), update any parameters as defined via command line arguments or in the parameters file and calculate all cells, resulting in an Excel spreadsheet resembling the original, but with all formula cells replaced by the calculated values.

Parameters that define how to update cells in your spreadsheet can be provided in three ways: JSON file, CSV file, or command line arguments

If both a config file and command line arguments are provided, the command line arguments

Config file formatting

Only one config file can be provided at a time. The config file can either be

Command line arguments:

Command line arguments take the form of:

-f "Sheet name.Cell1=Replacement value string" -f "Sheet name.Cell2=Replacement_value_float"

Note: Quotation marks are not required if there no space in the parameter string.

Example:

xlsxecute -f "Variables.C2=red" -f Variables.C3=0.8 sample.xlsx

JSON:

{
   "Sheet name.Cell1": "Replacement value string",
   "Sheet name.Cell2": Replacement_value_float
}

Example: params.json

{
    "Variables.C2": "red",
    "Variables.C3": 0.8
}

CSV:

Sheet name.Cell1,Replacement value string
Sheet name.Cell2,Replacement value float

Example: params.csv

Variables.C2,red
Variables.C3,0.8

NOTE: Do NOT include a header row in the CSV



Executable usage:

usage: xlsxecute [-h] [--output_dir OUTPUT_DIR] [--run_dir RUN_DIR] [--param {sheet}.{cell}={new_value}] source_file [parameter_file]

positional arguments:
  source_file           Excel (xlsx) file that contains the model
  parameter_file        Path to json or csv parameter file

optional arguments:
  -h, --help            show this help message and exit
  --output_dir OUTPUT_DIR
                        Optional output location. (Default: output)
  --run_dir RUN_DIR     Optional directory to store intermediate files. (Default: runs)
  --param {sheet}.{cell}={new_value}, -p {sheet}.{cell}={new_value}

Metadata

Release files for xlsxecute 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xlsxecute 0.2.0
File Size Uploaded
xlsxecute-0.2.0.tar.gz 4.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for xlsxecute 0.2.0
File Interpreter ABI Platform
xlsxecute-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 11.3 kB

Release files / xlsxecute-0.2.0.tar.gz

Download URL xlsxecute-0.2.0.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3472be88235d97e7ec5df71b740c487ca68bc8ce718c01e57a14e83a06db1a59
BLAKE2b-256 checksum
How to use checksums
d81979f89d4e4556e220ab0ad796062cc8f748fd753ee0b8adecc79d383767df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.8.10 Linux/5.14.0-1029-oem

Release files / xlsxecute-0.2.0-py3-none-any.whl

Download URL xlsxecute-0.2.0-py3-none-any.whl
Size 6.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e620fcfc7bed73a9d67f265b21dbc3f183e2b9b27551992e793660d23aed87a0
BLAKE2b-256 checksum
How to use checksums
25b09cd591bbfd94ed2d141451ceea86643414899ab206087ccc6560d2210c3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.8.10 Linux/5.14.0-1029-oem

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page