Skip to main content

A ghost teammate bot that pretends to work but does absolutely nothing.

Project description

Python Package Exercise

Ghosty: Your Ghost Teammate Bot

Build Status

PyPI: coming soon

Ghosty is a Python package that simulates a ghost teammate — the kind who gets assigned tasks, never does anything, and always has an excuse. Install it, assign Ghosty some work, and watch absolutely nothing happen.


Installation

pip install ghosty

Usage

greet()

Ghosty greets you (or doesn't, depending on the mood).

from ghosty import ghosty

ghosty.greet()

assign(task_name, hours, category="medium")

Assign Ghosty a task. It will be logged to the task board and promptly ignored.

  • task_name (str): Name of the task
  • hours (int/float): Estimated hours
  • category (str): Priority level — "low", "medium", "high", or "critical". Default: "medium"
ghosty.assign("Fix login bug", 3, category="high")
ghosty.assign("Write documentation", 2, category="low")

check_in(task_name=None)

View the task board. Pass a task name to see details on a specific task, or leave it empty to see everything.

ghosty.check_in()                  # view all tasks
ghosty.check_in("Fix login bug")   # view one task

nudge()

Nudge Ghosty to actually do something. Without a nudge, nothing will ever happen.

ghosty.nudge("Fix login bug")

excuse(reason, seriousness="medium")

Ask Ghosty to justify why no progress has been made.

  • reason (str): The excuse text
  • seriousness (str): How serious the excuse is — "low", "medium", or "high". Default: "medium"
ghosty.excuse("my cat sat on my keyboard", seriousness="medium")
ghosty.excuse("the wifi stopped believing in me", seriousness="high")

Example Program

See src/ghosty/__main__.py for a complete example using all functions.

Run it with:

python -m ghosty

Contributing

Setup

git clone https://github.com/swe-students-spring2026/3-package-blue_whale.git
cd 3-package-blue_whale
pipenv install --dev
pipenv shell

Running Tests

pipenv run pytest

Building the Package

pipenv run python -m build

Team

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

ghosty_teammate-0.0.1.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

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

ghosty_teammate-0.0.1-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file ghosty_teammate-0.0.1.tar.gz.

File metadata

  • Download URL: ghosty_teammate-0.0.1.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for ghosty_teammate-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f25f72b7167d96ac2b51cdd051675d1af6d1cb3fdf8efe01370775927d252a92
MD5 b889867139d260b8b5788b3f26e86edc
BLAKE2b-256 5443aff5658f47630102b834d96e51b03a5556a0a1a3299b961eba8d7513b196

See more details on using hashes here.

File details

Details for the file ghosty_teammate-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ghosty_teammate-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 789aed3bb374cad31fdde94588fe5ac59acf99a73f05b52f8bf236f1b0a25eef
MD5 1e4e75ea3d8d36685c95f30b3010231d
BLAKE2b-256 fbaa3b9d72dd649ea315b0a6c7815d52d1f3b967c119a0e78ee9271d8bb6c980

See more details on using hashes here.

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