Skip to main content

Installable CLI for the unofficial monarch-api Python client.

Project description

monarch-api-cli

Installable command-line interface for the published monarch-api Python client.

This repository is intended to become the public home of the CLI. The repository name and PyPI distribution name are both monarch-api-cli, while the installed command is simply monarch.

The package is organized as a real src/ application now:

  • src/monarch_cli/ contains the maintained CLI implementation.
  • tests/ covers payload-building behavior.

Install

From PyPI, the intended distribution name is:

pip install monarch-api-cli

With pipx:

pipx install monarch-api-cli

For local development:

pip install -e .[dev]

Usage

The primary console command is monarch:

monarch --help
monarch --help all
monarch household preferences
monarch transactions create --help

The saved session is stored at:

~/.monarch-api-cli/monarch_session.json

Older sessions from ~/.monarch-cli/monarch_session.json are still accepted and migrated forward on use.

Notes

  • monarch-api remains the underlying Python client, imported as monarch_api.
  • monarch-api-cli is the public repository and PyPI distribution for the CLI.
  • The installed command remains monarch.

Development

pip install -e .[dev]
python -m pytest
python -m build
python -m twine check dist/*

AI Skills

Repo-local agent skills live under skills/.

  • skills/monarch-finance-ops/ provides a reusable skill for analyzing, reconciling, budgeting, and safely managing Monarch financial data through this CLI.

Release

This project publishes the PyPI distribution monarch-api-cli and installs the console command monarch.

Before the first public release:

  1. Create the monarch-api-cli project on PyPI if it does not already exist.
  2. Configure PyPI Trusted Publishing for this repository.

For each release:

  1. Update version in pyproject.toml.
  2. Run verification:
python -m pip install -e .[dev]
python -m pytest
python -m build
python -m twine check dist/*
  1. Commit the release changes.
  2. Tag and push the release:
git tag v0.1.0
git push origin main --tags
  1. Create a GitHub release for the tag.
  2. The Publish To PyPI workflow will publish automatically if Trusted Publishing is configured.

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

monarch_api_cli-0.1.0.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

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

monarch_api_cli-0.1.0-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file monarch_api_cli-0.1.0.tar.gz.

File metadata

  • Download URL: monarch_api_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for monarch_api_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 661861c70eeb7fc76edda9851c9f446bf902dbaa583b81f42f5c4513b42e0d69
MD5 452a20ae4fee6f94a60f3aab3847fdc0
BLAKE2b-256 aa2fd370645f9fa4e4a27b3c3d172876949c5610b7d9dda9ce0fe3179b41f236

See more details on using hashes here.

Provenance

The following attestation bundles were made for monarch_api_cli-0.1.0.tar.gz:

Publisher: publish-pypi.yml on erikrubstein/monarch-api-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file monarch_api_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: monarch_api_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for monarch_api_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca7bae7fc5cdfb4594a0c759ef8d36817f78d73803cd046ecfa14bfe71552b11
MD5 e5d43e577155d5d7f92b27926b52db43
BLAKE2b-256 20c0d44436985586db6018941d560a97ae00645916fb2925e4f03625623b80fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for monarch_api_cli-0.1.0-py3-none-any.whl:

Publisher: publish-pypi.yml on erikrubstein/monarch-api-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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