Skip to main content

CLI for common MaybeAI spreadsheet operations

Project description

maybeai-sheet-cli

CLI for MaybeAI spreadsheet operations.

maybeai-sheet wraps the MaybeAI spreadsheet HTTP APIs behind a stable command-line interface for humans, CI jobs, and agents.

Install

On Debian/Ubuntu and other PEP 668 systems, do not use bare pip install on system Python. Use pipx (recommended for CLIs):

sudo apt install -y pipx python3-venv
pipx ensurepath
# re-login or: source ~/.bashrc

pipx install maybeai-sheet-cli
maybeai-sheet --version

For local venvs or macOS/dev machines, plain pip is fine:

pip install maybeai-sheet-cli

Upgrade to the latest release:

maybeai-sheet update          # when installed via pip or pipx
pipx upgrade maybeai-sheet-cli   # alternative on pipx installs

Install a specific version:

maybeai-sheet update --version 0.3.0
pipx install maybeai-sheet-cli==0.3.0 --force   # pipx reinstall pin

Uninstall:

pipx uninstall maybeai-sheet-cli
# not: pip uninstall -U  (-U is invalid for uninstall)

Requirements

  • Python 3.10+
  • MAYBEAI_API_TOKEN

Configure

Set your API token:

export MAYBEAI_API_TOKEN="YOUR_TOKEN"

Optional global flags:

  • --base-url to point at a different MaybeAI API host
  • --output json|table|yaml
  • --timeout <seconds>
  • --verbose

Quick Start

Read a workbook:

maybeai-sheet sheet read --doc-id abc123

List worksheets:

maybeai-sheet sheet worksheets --doc-id abc123

Read headers from a worksheet:

maybeai-sheet sheet headers --doc-id abc123 --gid 3

Create a workbook:

maybeai-sheet workbook create --title "Board Pack"

Upload a workbook-style .xlsx through the default Excelize path:

maybeai-sheet workbook create-from-file ./report.xlsx

Import a large table-like .xlsx into SheetTable/PG:

maybeai-sheet workbook create-from-file ./large-table.xlsx --engine postgres

Append rows and verify:

maybeai-sheet sheet append --doc-id abc123 --gid 3 --rows rows.json --verify

Make a workbook public for viewers:

maybeai-sheet share visibility --doc-id abc123 --visibility public --public-permission viewer

Commands

  • update
  • workbook create
  • workbook create-from-file
  • workbook manifest
  • workbook capabilities
  • share visibility
  • share grant
  • share permission
  • share remove
  • share list
  • sheet read
  • sheet read-range
  • sheet read-many
  • sheet named-range
  • sheet headers
  • sheet worksheets
  • sheet formulas
  • sheet write-range
  • sheet clear-range
  • sheet append
  • sheet formula-set
  • sheet formula-batch-set
  • sheet recalculate
  • sheet upsert
  • sheet create-worksheet
  • raw post

Input Rules

  • Use --doc-id, --url, or --uri to identify a workbook.
  • Use --worksheet-name when the endpoint supports it.
  • Use --gid for gid-specific sheet targeting.
  • File inputs like --rows, --values, --targets, and --operations must be JSON.

Output

Default output is JSON. table is optimized for sheet-like payloads; yaml is also supported.

Development

python3 -m venv .venv
. .venv/bin/activate
pip install -U pip
pip install -e .

Run tests:

python -m unittest discover -s tests -v

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

maybeai_sheet_cli-0.3.0.tar.gz (47.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maybeai_sheet_cli-0.3.0-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file maybeai_sheet_cli-0.3.0.tar.gz.

File metadata

  • Download URL: maybeai_sheet_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 47.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for maybeai_sheet_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1cfa000d2bbed88c26cd99727c055ff6caa934edab11035646a6a8bf30748e67
MD5 4429c6c33887b7642fd2f3b0a3010e61
BLAKE2b-256 a0def15ef0a52ec823deef14cc10f9c2212051f54f2a4cffed08eb4d913ed375

See more details on using hashes here.

File details

Details for the file maybeai_sheet_cli-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for maybeai_sheet_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d618665904c5b23f17c8b82c1b19ace341ab73d5da15511b7690e76904bbd1f
MD5 2d9c7ad4b594f399bca24ca61e31f335
BLAKE2b-256 13d44a020b847980ace4149a8f75716cfc4dcab3f63627e690e40fcdf58a057e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page