Skip to main content

Monorepo workspace for owa-piggy consumer CLIs

Project description

owa-tools

Pipe-friendly CLI suite for Outlook and Microsoft 365. Calendar, mail, Graph, OneDrive, scheduling, people lookup, health checks - all from your terminal, all returning JSON by default.

PyPI GitHub release License: MIT

No Azure AD app registration. No third-party runtime dependencies. Auth piggybacks on the OWA browser session via owa-piggy

  • separate package, separate token store, never imported.

Suite

owa-tools is the M365 read/write surface in the hugr memory suite, alongside YAAMS (Tier 1 raw), cognitive-ledger (Tier 2 curated), and owa-piggy (auth broker). The suite gives you one install (brew install damsleth/tap/hugr), one verb surface (hugr mail ..., hugr calendar ...), and one CLI contract (output classes, exit codes, JSON envelopes - see hugr/CONVENTIONS.md). The nine owa-* binaries continue to work standalone.

Install

Homebrew (recommended):

brew install damsleth/tap/owa-piggy damsleth/tap/owa-tools

PyPI:

pipx install owa-piggy && pipx install owa-tools

Either path lands twelve binaries on your PATH (owa, owa-cal, owa-mail, owa-graph, owa-doctor, owa-people, owa-sched, owa-drive, owa-todo, owa-planner, owa-sites, owa-teams) plus the owa-piggy auth broker.

Quickstart

# 1. One-time auth setup (opens Edge, signs you in, captures a refresh token)
owa-piggy setup --profile work --email you@yourcompany.com

# 2. Verify everything's healthy
owa doctor

# 3. Try it
owa-cal events --pretty                          # today's calendar
owa-mail folders                                 # mail folders
owa-graph me whoami                              # who am I
owa-drive ls                                     # OneDrive root
owa-people find "ola nordmann"                   # people lookup
owa-sched availability --who you@example.com --date today

Every binary supports --help and <binary> help for the full command surface. JSON on stdout, logs on stderr, --pretty when you want a human-readable table.

The owa umbrella also dispatches to any tool, so owa cal events --pretty is equivalent to owa-cal events --pretty — everything after the tool name is passed straight through.

What's in the box

CLI What it does
owa-cal Calendar CRUD over Outlook REST. Events, categories, recurrence.
owa-mail Mail CRUD: messages, send, reply, forward, folders.
owa-graph Microsoft Graph CLI: verb-first plus 14 resource shortcut groups.
owa-people People, directory, and contacts via Graph.
owa-sched Free/busy and slot finding for one or many attendees.
owa-drive OneDrive CRUD plus binary up/download.
owa-doctor Health check across the suite, all profiles, all audiences.
owa-todo Microsoft To Do tasks: lists, create, update, complete, delete.
owa-planner Microsoft Planner (read-only): plans, buckets, tasks, task detail.
owa-sites SharePoint (read-only) via SharePoint REST: site, lists, items, files, search.
owa-teams Microsoft Teams (read-only): joined teams, channels, chats, and channel/chat messages (threaded).
owa Umbrella: suite meta (owa list, owa schema, owa version, owa --doctor) plus owa <tool> ... pass-through dispatch (e.g. owa cal events).

Multi-account / profiles

Each tool delegates auth to owa-piggy and inherits its profile model. Pin a profile for a tool, switch per call, or set it via env:

owa-cal --profile crayon events --pretty         # one call
OWA_PROFILE=crayon owa-cal events --pretty       # one shell session
owa-cal config --profile crayon                  # persistent for owa-cal

Repeat --profile to fan out across profiles in one call - results are merged keyed by profile (exit 0 all ok, 2 mixed, 1 all failed):

owa-mail --profile crayon --profile brkh messages --unread   # both inboxes, merged

See docs/profile-model.md for the full precedence rules.

For agents and automation

  • JSON on stdout by default. --pretty is the human opt-in.
  • --agent wraps output for automation tooling; --err-json emits structured stderr.
  • owa schema aggregates per-tool schemas for discovery.
  • Exit code taxonomy is shared across the suite (docs/agent-integration.md).

Docs

Maintainer reference:

Releases

Contributing

See CONTRIBUTING.md for setup, tests, coverage gates, commit conventions, and code style. The release flow lives in RELEASING.md, and architecture/agent guidance lives in AGENTS.md.

License

MIT.

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

owa_tools-0.7.0.tar.gz (237.0 kB view details)

Uploaded Source

Built Distribution

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

owa_tools-0.7.0-py3-none-any.whl (275.4 kB view details)

Uploaded Python 3

File details

Details for the file owa_tools-0.7.0.tar.gz.

File metadata

  • Download URL: owa_tools-0.7.0.tar.gz
  • Upload date:
  • Size: 237.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for owa_tools-0.7.0.tar.gz
Algorithm Hash digest
SHA256 8d355beb89fd53819b168f9dddb3b9099ea17b601b89b53f1e89e3aa2950ecda
MD5 2e09002d2aa19b60bfa49cc15689eebb
BLAKE2b-256 291b5215fb4bb8965b67464101661f2e6d1fdc1861052bc6d48a2479fe58a587

See more details on using hashes here.

File details

Details for the file owa_tools-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: owa_tools-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 275.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for owa_tools-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 832edf64eb3273b7965e5338801ffc7463e30bfffd2c7aa76447bbc563b21499
MD5 6838d7ad996575bdbd6b08fe318b9c5a
BLAKE2b-256 57aa27ac4249749406727793245c4cf028ced094db6e0b857b91a2799fe55134

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