Skip to main content

A command line tool for interacting with Goodbudget

Project description

goodbudget_cli

Command line tool to enter transactions into your Goodbudget account.

Installation

Dependencies

Install with pipx (or pip)

$ pipx install goodbudget-cli

Initialize and edit the configuration file

  1. Run gb to initially create a ~/.config/goodbudget_cli/config.json file.
  2. Edit the config.json file to set the webdriver_path to the location of your Chrome webdriver.
  3. Edit the config.json file to set the Envelopes using the name of your Goodbudget envelopes using the format of {ENVELOPE_NAME: [LIST OF ALIASES]}.

Usage

To enter an expense:

$ gb {Goodbudget household username or email}

To enter income:

$ gb {Goodbudget household username or email}  --income

Demo

$ gb foo@bar.com
Enter your Goodbudget password:
Logging in. Please wait...
Logged in.

Date of transaction (today / yesterday / mm/dd/yyyy): today
Payee: QFC
Amount: 40
Envelope (or type in 'remind'): groceries
Notes (optional):

        Summary of your expense:

            Date: 01/28/2023
            Payee: QFC
            Amount: $40
            Envelope: Groceries (based on your alias of 'groceries')
            Notes: <none>

Is everything correct? (Y/n) Y
Entering expense. Please wait...

Success! Your transaction was entered into Goodbudget.

Do you want to enter another transaction? (Y/n) n

Thank you for using goodbudget_cli! See you next time!

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

goodbudget_cli-0.2.1.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

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

goodbudget_cli-0.2.1-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file goodbudget_cli-0.2.1.tar.gz.

File metadata

  • Download URL: goodbudget_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for goodbudget_cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ecbf065c22e3837585483536491b1a7b38e5e8b1f9d0f7216420d9535dbff372
MD5 3a3f4024f14cf6c2a4c2432158cf605c
BLAKE2b-256 8db78c6a20de81daafc0886aad968f309abadecfffc71f87b94cfbccd2b70175

See more details on using hashes here.

File details

Details for the file goodbudget_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: goodbudget_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for goodbudget_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3980382b1fee77428c8c8e147ebb9bfa9cc40e779f3d930e998513b405e967c3
MD5 22b418d6c07de0d3084b0bd470967685
BLAKE2b-256 35633094a2b265e975e1e91ceef233c8100eeee78f0c28f7bfe01454dc8b5fb3

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