Skip to main content

Splitting group expenses made it fun on your terminal

Project description

splitty-cli

Terminal first ASCII powered PyPI version Split drama PyPI status Python versions License Publish package to PyPI

splitty-cli is a Python terminal application for splitting shared expenses with a polished interactive flow, colorful terminal dashboards, and clean settlement suggestions.

Features

  • guided step-by-step CLI powered by Typer
  • styled prompts, tables, panels, and dashboards with Rich
  • animated intro and terminal charts, with a no-animation mode for simpler sessions
  • equal split calculations with cent-accurate rounding
  • minimized settlement transfers between debtors and creditors
  • expense analytics with terminal charts
  • optional JSON export for every completed session
  • modular business logic with Pydantic validation and pytest coverage

Installation

pip install splitty-cli

Quickstart

Run the interactive app:

splitty-cli

Disable the animated intro when you want a quieter run, a simpler terminal capture, or better compatibility with a limited terminal:

splitty-cli --no-animations

You can also disable animations with an environment variable:

SPLITTY_NO_ANIMATIONS=1 splitty-cli

Follow the prompts to:

  1. name the event
  2. add the participants
  3. enter each expense
  4. review balances, settlements, and charts
  5. optionally export the session to JSON

JSON export

Write the final report to a JSON file:

splitty-cli --export-json reports/weekend-trip.json

In the interactive flow, JSON backups are stored by default in ~/.splitty-cli/backups/ and use the pattern <event-name>-YYYY-MM-DD.json. If you confirm the export at the end of the session, the CLI only asks for the backup file name and keeps the file inside that folder.

The exported report includes:

  • event summary
  • participant balances
  • settlement transfers
  • analytics insights
  • expense and payer breakdown data

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

splitty_cli-0.1.0b1.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

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

splitty_cli-0.1.0b1-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file splitty_cli-0.1.0b1.tar.gz.

File metadata

  • Download URL: splitty_cli-0.1.0b1.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for splitty_cli-0.1.0b1.tar.gz
Algorithm Hash digest
SHA256 14234ef880956ac5ab5a4a521116c072657bd9654acc444e2c410a990ff7fb20
MD5 192931907a3c36e66d294568e1cf129e
BLAKE2b-256 7865d466289023334d3cf28db6e73a20237584dce7c16ec5b79ca8c7a1b5fdff

See more details on using hashes here.

Provenance

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

Publisher: publish-pypi.yml on 0xlukem/Split-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 splitty_cli-0.1.0b1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for splitty_cli-0.1.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 3b39279b41d189fda47e720f8b46f55743313033d3bab46947ca77cd54fce11f
MD5 d461bd40b455179d168feff4c2744ecd
BLAKE2b-256 c78ee4fc76d4f78c37ea6c327f70b02cc8391d86f327469d54ac1e43c420b300

See more details on using hashes here.

Provenance

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

Publisher: publish-pypi.yml on 0xlukem/Split-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