Simple rock-paper-scissors CLI
Project description
chanwookim-rps
Simple rock-paper-scissors CLI game.
Features
- Interactive terminal game with score tracking
- Simple CLI entry point after installation (
rps) - Support for multiple command aliases
Prerequisites
- Python 3.8+
Installation
From TestPyPI (Recommended for testing the published package)
pip install --index-url https://test.pypi.org/simple/ --no-deps chanwookim-rps
From GitHub repository
pip install git+https://github.com/chanwookim0716/chanwookim-rps.git
Local Installation
Navigate to the project root directory and run:
pip install --user .
For Development (Editable Install)
Navigate to the project root directory and run:
pip install -e .
Usage
After installation, you can run the CLI command:
rps
In-Game Commands
Main Menu:
gameorplay- Start a new gamehelporrules- View game rulesexitorquit- Exit the game
During Game:
scissors,rock,paper- Make your choicequitorexit- Return to main menu
Development
Running Unit Tests
To ensure the core game logic is working correctly, run the unit tests:
python -m unittest tests/test_rps.py
Running the Test Runner
A simple test runner (with scripted inputs) is available to exercise the game logic:
python tests/_test_rps_runner.py
Contributing
- Fork the repo, make changes, and open a pull request. Keep changes small and focused.
License
This project is licensed under the LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chanwookim_rps-0.0.1.tar.gz.
File metadata
- Download URL: chanwookim_rps-0.0.1.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
607956445422805e6790c59a889cd89d9a40fccf0e9e3fd2deb808b7bb0a49d9
|
|
| MD5 |
e01ccba6b718824e855829c7b2ec4995
|
|
| BLAKE2b-256 |
57a38bf72e13f5ffe449220efb32ca820ac7918bb686bf9f350b004eaf9fff16
|
File details
Details for the file chanwookim_rps-0.0.1-py3-none-any.whl.
File metadata
- Download URL: chanwookim_rps-0.0.1-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1adb1eed7831c888cbb6bbf835b60d8bc8fdf99f6b26e398e470c7546ef82d72
|
|
| MD5 |
39eb758205d89395087757fbf7f9150c
|
|
| BLAKE2b-256 |
ceb4c1068be4ff027b1ea6363b7f4250f4eec9a4aa2fbbd20d38d7959fd5f564
|