https://github.com/brianlusina/hangman

Simple Text Based User Interface game of Hangman built with Python
https://github.com/brianlusina/hangman

hangman-game hangman-in-python python python3 text-based-game text-based-ui

Last synced: about 1 month ago
JSON representation

Simple Text Based User Interface game of Hangman built with Python

• Host: GitHub
• URL: https://github.com/brianlusina/hangman
• Owner: BrianLusina
• License: mit
• Created: 2023-11-27T14:38:14.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-09-13T09:39:12.000Z (2 months ago)
• Last Synced: 2024-09-13T23:24:45.609Z (2 months ago)
• Topics: hangman-game, hangman-in-python, python, python3, text-based-game, text-based-ui
• Language: Python
• Homepage:
• Size: 313 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Hangman

[![Build](https://github.com/BrianLusina/hangman/actions/workflows/build.yml/badge.svg)](https://github.com/BrianLusina/hangman/actions/workflows/build.yml)

[![Lint](https://github.com/BrianLusina/hangman/actions/workflows/lint.yml/badge.svg)](https://github.com/BrianLusina/hangman/actions/workflows/lint.yml)

[![Tests](https://github.com/BrianLusina/hangman/actions/workflows/tests.yaml/badge.svg)](https://github.com/BrianLusina/hangman/actions/workflows/tests.yaml)

This is a command line game application inspired by [Hangman](https://en.wikipedia.org/wiki/Hangman_(game)) which is a

word skill game that teaches basic language skills. This game is between the computer and one human player. The computer

will act as the selecting plater and will select

the word to guess, process human input and handle all output.

The human player is the guessing player, simply referred to as the player. When the player knows the word, they continue

to guess correct letters until the word is complete.

You can change the words the game will select in the [words.txt](./hangman/words.txt) file with a different choice of

words.

## Pre-requisites

1. Ensure that you have [Python version 3.12.0](https://www.python.org/) setup locally, you can set this up

   using [pyenv](https://github.com/pyenv/pyenv) if you have multiple versions of Python on your local development

   environment.

2. [Poetry](https://python-poetry.org/) is used for managing dependencies, ensure you have that setup locally.

3. [Virtualenv](https://virtualenv.pypa.io/) Not a hard requirement as poetry should setup a virtual environment for

   you, but can be used as well to setup a virtual environment.

## Setup

1. After cloning the project, install the dependencies required with:

   ```shell

   poetry install

   ```

   > When using poetry

   Or

   ```shell

   make install

   ```

   > When using [GNU Make](https://www.gnu.org/s/make/manual/make.html), this is a wrapper around the top commend

2. Install `hangman` in editable mode:

   ```shell

   cd hangman

   pip install -e .

   ```

## Execution

To execute `hangman`, go ahead and run the below command:

```shell

python hangman

```

Which will run the game. Enjoy!