Terminal snake game
A simple snake game right in your terminal using python built-in curses package.
Tools/features
Production
- python 3.4, 3.5, 3.6, 3.7, 3.8
- curses
- OS compatibility
- Linux
- Mac
- docker
Development
Usage
Please press esc or cntl+c to stop the game.
Docker installation
Please run following script to obtain application from docker hub:
docker run -it vyahello/cli-snakegame:0.1.0
PYPI installation
Please run following script to obtain latest package from PYPI:
pip install cli-snakegame
Please execute pysnake
CLI tool from your shell:
pysnake
Run from source code
Please execute command from the root of your source directory:
python -m snake
Development notes
Run code analysis
In general static code analysis consists of following tools: black
, flake8
, pylint
, mypy
and unittests
accordingly.
To be able to start static code analysis locally please run following script from the root directory of the project:
./analyse-code.sh install-dependencies
Anyway, this script is triggered via Travis CI
.
Run unittests
Also you can run unittests separately. Please run script from the root directory of the project:
pytest
After please open test-report.html
file to see detailed testing report
Release notes
Please refer to CHANGELOG file to get more details
Meta
Author – Volodymyr Yahello (vyahello@gmail.com).
Distributed under the GNU
license. See LICENSE for more information.
You can reach out me at:
Contributing
- clone the repository
- configure Git for the first time after cloning with your
name
andemail
-
pip install -r requirements.txt
to install all project dependencies -
pip install -r requirements-dev.txt
to install all project development dependencies