echo-bot

echo-bot is a simple command-line chatbot designed for quick and interactive conversations directly in your terminal.

💻 Prerequisites

• Python ^3.13 (Download Python)
• Poetry 2.0 (Poetry installation guide)

📦 Installation

Clone the repository and install dependencies:

git clone https://github.com/rcw3bb/echo-bot.git
cd echo-bot
poetry install

Ensure that a GITHUB_TOKEN environment variable is in your system with your GitHub Models API token:

GITHUB_TOKEN=your_github_models_token_here

⚡ Usage

Run the chatbot in your terminal:

poetry run python -m echo_bot

Commands

• Type your message and press Enter to chat.
• Type exit or quit to leave the chatbot.
• Type /reset to clear the conversation context and start a new session.

🔧 Development

• All source code is in the echo_bot package.
• Tests are in the tests package.

🔬 Testing & Coverage

Run all tests and generate an HTML coverage report:

poetry run pytest --cov=echo_bot tests --cov-report html

Open htmlcov/index.html to view the coverage report.

🎨 Formatting & Linting

Format and lint the code in one step:

poetry run black echo_bot && poetry run pylint echo_bot

📜 Changelog

See CHANGELOG.md for release history.

🔑 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

🖊️ Author

Ron Webb