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.
