Skip to main content

A polished Python terminal UI for coffee-themed developer workflows.

Project description

Coffee CLI

Coffee CLI is a Python terminal UI application for developers who want a polished, installable coffee command with personality. The app is built as a modern Python package and is intended to grow into a showcase project for terminal UX, testing, CI/CD, and professional packaging.

Project goals

  • Launch with coffee after installation.
  • Use Textual for a polished TUI.
  • Keep the codebase educational and production-leaning.
  • Validate every change with tests, linting, and CI.

Local environment

This project is being developed inside:

  • project root: /home/redsteam/Desktop/bear/ML/coffee-for-devs
  • virtual environment: /home/redsteam/Desktop/bear/ML/MLprojs

Activate the environment:

source /home/redsteam/Desktop/bear/ML/MLprojs/bin/activate

First-time setup

Install the project and developer tools into the virtual environment:

python -m pip install -e ".[dev]"

Run the quality checks:

ruff check .
pytest
python -m build

Start the app:

coffee

Install from a wheel

Build the package:

python -m build

Install the generated wheel into a fresh environment:

python -m pip install dist/coffee_cli-0.1.0-py3-none-any.whl
coffee

This is the local release-candidate check before publishing to PyPI.

Release publishing

Publishing is handled by the manual GitHub Actions workflow in .github/workflows/publish.yml. Use target=testpypi first, verify the package, then publish to PyPI from a version tag such as v0.1.0.

Current scope

Coffee CLI currently includes:

  • modern pyproject.toml packaging
  • src/ layout
  • coffee console script entry point
  • first Textual app skeleton with animated ASCII steam
  • order flow, brewing flow, personal favorites, journal, and statistics
  • tested package structure
  • GitHub Actions CI workflow

See docs/roadmap.md for the planned sprint breakdown, docs/milestones.md for runnable milestones, docs/release-checklist.md for release steps, and CONTRIBUTING.md for the Git workflow.

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

coffee_cli-0.1.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

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

coffee_cli-0.1.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for coffee_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f70c4015d3dca9faf41cc9c4e9ef2b9eb063fe0bd1ceb108420432c1483f58ed
MD5 4a8c9dce67ec1511b2be987d40e0da25
BLAKE2b-256 8785e4b73f612993beb7a78c9cb9a8418827ae38bc6c2ee68fa899d4066313ee

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on josephforson285/coffee-for-devs

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

File details

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

File metadata

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

File hashes

Hashes for coffee_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5c8aeae91bced0ab306152fea9ccf76b661a58b7e37ca1690cf565b36b396db
MD5 af04c4820a4bb254c2f497998a5dcee3
BLAKE2b-256 d846e53580d50e33a745022d2b1a1d923d6c7d2e9f9a6638a7abc4efcefdaaae

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on josephforson285/coffee-for-devs

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