Skip to main content

# SpreadScript: Use a spreadsheet as a function This project provides a way to use spreadsheets from the command line or from Python programs.

The inputs and outputs are defined by two tables in a new sheet named “Interface”. SpreadScript will read the input variables from column B and the values from column C. Likewise, the output variables are read from column E and their values from column F. In both cases, the variables are read from row 4 onward until an empty cell is encountered.

## Installation Prerequisites:

apt install python3-uno

Via [PyPI](https://pypi.python.org/pypi/spreadscript):

pip3 install spreadscript

From source:

git clone https://github.com/jfjlaros/spreadscript.git cd spreadscript pip3 install .

## Usage Suppose we have the following table.

![Example table.](data/example_table.png)

If we want to define a and b as input variables and total as the output variable, we first add a new sheet named “Interface”.

![Example interface.](data/example_interface.png)

In this sheet we put the input variables in column B and the values in column C. The value of C4 is =$Sheet1.C3, that of C5 is =$Sheet1.C4.

Likewise, the output variables are put in column E and the values in column F. In this example, the value in F4 is =$Sheet1.C8.

### Command line interface With the command line interface, the input and output table can be read.

$ spreadscript read_input data/test.ods {“b”: 2.0, “a”: 1.0}

$ spreadscript read_output data/test.ods {“total”: 15.0}

To manipulate the input, use the process subcommand:

$ spreadscript process data/test.ods ‘{“b”: 12.0}’ {“total”: 25.0}

### Library First import the SpreadScript class and load a spreadsheet.

`python >>> from spreadscript import SpreadScript >>> >>> spreadsheet = SpreadScript('data/test.ods') `

The input variables can be read with the read_input method.

`python >>> spreadsheet.read_input() {'b': 2.0, 'a': 1.0} `

The read_output method returns all output variables.

`python >>> spreadsheet.read_output() {'total': 15.0} `

The write_input method is used to update any variables.

`python >>> spreadsheet.write_input({'b': 4.0}) >>> spreadsheet.read_output() {'total': 17.0} `

Metadata

Release files for spreadscript 0.0.3

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

Source distribution (sdist)

Source distribution for spreadscript 0.0.3
File Size Uploaded
spreadscript-0.0.3.tar.gz 4.7 kB Details

Release files / spreadscript-0.0.3.tar.gz

Download URL spreadscript-0.0.3.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
55cb0ab844f3bea1755d37a9f1d1ec36e1edf0c83d8a8bf668e5f121592964aa
BLAKE2b-256 checksum
How to use checksums
d5b26eaa928a58f33c4f695b2b6e3f80c5667449f434a47f189b7f3619b62eba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.3 This release

1 release file

0.0.2

1 release file

0.0.1

1 release file

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