cli-snakegame 1.2.1

A simple snake game right in your command line. Just try it, it is fun :)

Terminal snake game

A simple snake game right in your terminal using python built-in curses package. Just try it, it is fun :)

Tools/features

• python 3.4 | 3.5 | 3.6 | 3.7 | 3.8
• curses
• travis CI
• PYPI distribution
• code analysis
  • pytest
  • mypy
  • black
  • pylint
  • flake8

Usage

Please press esc or cntl+c to stop the game.

Installation

Please run following script to obtain latest package from PYPI:

➜ pip install cli-snakegame

Then 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 --run --name pysnake

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

• 1.2.0
  • Add CLI tool
• 1.1.1
  • Add link to curses package in readme
• 1.1.0
  • Support python >=3.4 version
  • Support python >=3.5 version
• 1.0.1
  • Polish documentation
• 1.0.0
  • Introduce PYPI package
• 0.2.0
  • Add navigation options
• 0.1.0
  • Introduce initial app version

Meta

Author – Volodymyr Yahello [e-mail]

Distributed under the GNU license. See LICENSE for more information.

You can reach out me at:

• https://github.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

1. clone the repository
2. configure Git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all project development dependencies