coffee-cli 0.1.0__tar.gz

coffee_cli-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,26 @@
+## Summary
+
+- 
+
+## Runnable Demo
+
+Command:
+
+```bash
+coffee
+```
+
+What should be visible:
+
+- 
+
+## Checks
+
+- [ ] `ruff check .`
+- [ ] `pytest`
+- [ ] `python -m build`
+
+## Sprint / Milestone
+
+- 
+

coffee_cli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip && python -m pip install -e ".[dev]"
+
+      - name: Show environment
+        run: |
+          python --version
+          python -m pip show textual pytest anyio
+
+      - name: Run Ruff
+        run: python -m ruff check .
+
+      - name: Run tests
+        run: python -m pytest -vv --tb=long
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload package artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: coffee-cli-dist-python-${{ matrix.python-version }}
+          path: dist/*

coffee_cli-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,87 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      target:
+        description: Package index to publish to
+        required: true
+        default: testpypi
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload package artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: coffee-cli-dist
+          path: dist/*
+
+  publish-testpypi:
+    if: github.event.inputs.target == 'testpypi'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/coffee-cli
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download package artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: coffee-cli-dist
+          path: dist
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    if: github.event.inputs.target == 'pypi'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/coffee-cli
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Require a version tag for PyPI
+        run: |
+          if [[ "${GITHUB_REF}" != refs/tags/v* ]]; then
+            echo "Real PyPI publishing must be run from a version tag like v0.1.0."
+            exit 1
+          fi
+
+      - name: Download package artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: coffee-cli-dist
+          path: dist
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

coffee_cli-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.pytest_cache/
+.ruff_cache/
+.coverage
+__pycache__/
+*.py[cod]
+*.egg-info/
+.mypy_cache/
+.tox/
+.venv/
+build/
+dist/
+.DS_Store
+

coffee_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+Coffee CLI follows a branch-and-PR workflow. Treat `main` as the stable branch.
+
+## Workflow
+
+1. Start from an up-to-date `main`.
+
+```bash
+git switch main
+git pull origin main
+```
+
+2. Create a branch for one focused change.
+
+```bash
+git switch -c feature/playable-home-screen
+```
+
+Use these prefixes:
+
+- `feature/` for user-facing app work
+- `fix/` for bug fixes
+- `docs/` for documentation
+- `ci/` for workflow and automation changes
+- `test/` for test-only improvements
+
+3. Make small commits with clear messages.
+
+```bash
+git add .
+git commit -m "Add playable home screen"
+```
+
+4. Run the full local checks.
+
+```bash
+ruff check .
+pytest
+python -m build
+```
+
+5. Push the branch and open a pull request.
+
+```bash
+git push -u origin feature/playable-home-screen
+```
+
+6. Merge only after CI passes.
+
+## Main branch rules
+
+- Do not do feature work directly on `main`.
+- Do not push directly to `main` after the initial project bootstrap.
+- Keep each PR focused on one milestone, bug, or workflow improvement.
+- Make sure every runnable milestone can be launched with `coffee`.
+

coffee_cli-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: coffee-cli
+Version: 0.1.0
+Summary: A polished Python terminal UI for coffee-themed developer workflows.
+Project-URL: Homepage, https://github.com/josephforson285/coffee-for-devs
+Project-URL: Issues, https://github.com/josephforson285/coffee-for-devs/issues
+Author: Coffee CLI Contributors
+License: MIT
+Keywords: cli,coffee,terminal,textual,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Terminals
+Requires-Python: >=3.12
+Requires-Dist: textual<1.0,>=0.68
+Provides-Extra: dev
+Requires-Dist: anyio>=4.4; extra == 'dev'
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.2; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# 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:
+
+```bash
+source /home/redsteam/Desktop/bear/ML/MLprojs/bin/activate
+```
+
+## First-time setup
+
+Install the project and developer tools into the virtual environment:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Run the quality checks:
+
+```bash
+ruff check .
+pytest
+python -m build
+```
+
+Start the app:
+
+```bash
+coffee
+```
+
+## Install from a wheel
+
+Build the package:
+
+```bash
+python -m build
+```
+
+Install the generated wheel into a fresh environment:
+
+```bash
+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](docs/roadmap.md) for the planned sprint breakdown, [docs/milestones.md](docs/milestones.md) for runnable milestones, [docs/release-checklist.md](docs/release-checklist.md) for release steps, and [CONTRIBUTING.md](CONTRIBUTING.md) for the Git workflow.

coffee_cli-0.1.0/README.md

@@ -0,0 +1,82 @@
+# 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:
+
+```bash
+source /home/redsteam/Desktop/bear/ML/MLprojs/bin/activate
+```
+
+## First-time setup
+
+Install the project and developer tools into the virtual environment:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Run the quality checks:
+
+```bash
+ruff check .
+pytest
+python -m build
+```
+
+Start the app:
+
+```bash
+coffee
+```
+
+## Install from a wheel
+
+Build the package:
+
+```bash
+python -m build
+```
+
+Install the generated wheel into a fresh environment:
+
+```bash
+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](docs/roadmap.md) for the planned sprint breakdown, [docs/milestones.md](docs/milestones.md) for runnable milestones, [docs/release-checklist.md](docs/release-checklist.md) for release steps, and [CONTRIBUTING.md](CONTRIBUTING.md) for the Git workflow.

coffee_cli-0.1.0/docs/milestones.md

@@ -0,0 +1,158 @@
+# Runnable Milestones
+
+This project should grow in small playable slices. A milestone is not complete just because code exists; it should give a visible result that can be launched locally with `coffee`.
+
+## Milestone 0: Project Foundation
+
+Status: done
+
+Goal: make Coffee CLI a real Python project with packaging, tests, linting, CI, and a GitHub remote.
+
+Runnable demo:
+
+```bash
+source /home/redsteam/Desktop/bear/ML/MLprojs/bin/activate
+coffee
+```
+
+Expected result:
+
+- the `coffee` command starts the Textual app
+- the first home screen renders
+- the app can quit with `q`
+
+Verification:
+
+```bash
+ruff check .
+pytest
+python -m build
+```
+
+## Milestone 1: Playable Home Screen
+
+Status: done
+
+Goal: make the first screen feel intentional and easy to inspect.
+
+Playable behavior:
+
+- animated steam is visible
+- arrow keys move through the menu
+- the selected menu item updates the right-side summary
+- `q` exits cleanly
+
+Demo script:
+
+```bash
+coffee
+```
+
+Definition of done:
+
+- user can navigate the home menu
+- UI text fits cleanly in the terminal
+- tests cover pure rendering and menu state logic
+- Ruff, Pytest, and build pass
+
+## Milestone 2: First Order Flow
+
+Status: done
+
+Goal: let the user create a basic coffee order.
+
+Playable behavior:
+
+- choose a coffee type
+- choose a size
+- choose a milk option
+- see a live summary
+- confirm or cancel the order
+
+Demo script:
+
+```bash
+coffee
+```
+
+Definition of done:
+
+- one full order can be completed from the TUI
+- price calculation is tested
+- order summary is tested
+- CI passes
+
+## Milestone 3: Brewing Moment
+
+Status: done
+
+Goal: make order confirmation feel memorable.
+
+Playable behavior:
+
+- confirming an order starts a brewing animation
+- progress states show grinding, heating, brewing, and pouring
+- final screen shows the completed drink
+
+Demo script:
+
+```bash
+coffee
+```
+
+Definition of done:
+
+- animation completes without blocking input forever
+- user can return to the home screen
+- tests cover the brewing state transitions
+
+## Milestone 4: Personal Coffee Tools
+
+Status: done
+
+Goal: add reasons to reuse the app.
+
+Playable behavior:
+
+- save favorite drinks
+- open a coffee journal
+- view simple statistics
+
+Demo script:
+
+```bash
+coffee
+```
+
+Definition of done:
+
+- favorites persist locally
+- journal entries persist locally
+- storage behavior is tested
+
+## Milestone 5: Release Candidate
+
+Status: in progress
+
+Goal: prepare Coffee CLI for other developers to install.
+
+Playable behavior:
+
+- install from a built wheel
+- run `coffee` from a fresh environment
+- CI builds release artifacts
+
+Demo script:
+
+```bash
+python -m build
+python -m pip install dist/coffee_cli-0.1.0-py3-none-any.whl
+coffee
+```
+
+Definition of done:
+
+- README has installation instructions
+- GitHub release checklist exists
+- package metadata is complete
+- CI artifacts are reliable

coffee_cli-0.1.0/docs/release-checklist.md

@@ -0,0 +1,46 @@
+# Release Checklist
+
+Use this checklist before tagging a Coffee CLI release or publishing to PyPI.
+
+## Local Release Candidate
+
+- Start from an up-to-date `main`.
+- Create a focused release branch.
+- Run `python -m pip install -e ".[dev]"`.
+- Run `python -m ruff check .`.
+- Run `python -m pytest`.
+- Run `python -m build`.
+- Create a fresh virtual environment.
+- Install the wheel with `python -m pip install dist/coffee_cli-0.1.0-py3-none-any.whl`.
+- Run `coffee` and verify the TUI opens.
+
+## Pull Request Gate
+
+- Open a PR from the release branch.
+- Confirm GitHub Actions passes.
+- Confirm the CI run uploads `dist/` artifacts.
+- Review package metadata in `pyproject.toml`.
+- Review README installation instructions.
+- Merge only after the release-candidate demo works.
+
+## Future PyPI Release
+
+- Create PyPI and TestPyPI accounts.
+- Configure Trusted Publishing for this GitHub repository on TestPyPI.
+- Run the `Publish` workflow manually with `target=testpypi`.
+- Install from TestPyPI in a clean environment.
+- Merge the release-candidate PR after CI and TestPyPI verification pass.
+- Create a Git tag such as `v0.1.0` from `main`.
+- Configure Trusted Publishing for this GitHub repository on PyPI.
+- Run the `Publish` workflow manually from the tag with `target=pypi`.
+- Install from PyPI in a clean environment.
+
+Trusted Publishing settings:
+
+- TestPyPI project name: `coffee-cli`
+- PyPI project name: `coffee-cli`
+- Owner: `josephforson285`
+- Repository: `coffee-for-devs`
+- Workflow name: `publish.yml`
+- TestPyPI environment: `testpypi`
+- PyPI environment: `pypi`

coffee_cli-0.1.0/docs/roadmap.md

@@ -0,0 +1,49 @@
+# Coffee CLI Roadmap
+
+## Product framing
+
+Coffee CLI should feel like a real developer tool, not a classroom menu script. The coffee theme gives the app character, but the engineering quality, UX polish, and delivery workflow are the real value.
+
+## Sprint 1
+
+Goal: ship the first installable `coffee` command.
+
+- create Python package structure
+- wire the `coffee` console entry point
+- build a welcome screen with animated ASCII steam
+- add core tests
+- add Ruff, Pytest, and build automation in CI
+
+Runnable milestone: see [milestones.md](milestones.md#milestone-0-project-foundation) and [milestones.md](milestones.md#milestone-1-playable-home-screen).
+
+## Sprint 2
+
+Goal: support a complete coffee ordering flow.
+
+- add coffee selection
+- add milk and size selection
+- calculate prices
+- show an order summary
+- add tests for ordering and pricing logic
+
+Runnable milestone: see [milestones.md](milestones.md#milestone-2-first-order-flow).
+
+## Later sprints
+
+- themes and settings
+- favorites
+- coffee journal
+- statistics dashboard
+- search and command palette
+- plugin architecture
+- optional AI barista
+
+## Definition of done
+
+- code works locally
+- the milestone has a visible `coffee` demo
+- tests exist for the change
+- `ruff check .` passes
+- `pytest` passes
+- `python -m build` passes
+- CI passes before merge