Metadata-Version: 2.1
Name: cli-snakegame
Version: 1.1.1
Summary: A simple snake game right in your command line. Just try it, it is fun :)
Home-page: https://github.com/vyahello/snakegame-cli
Author: Volodymyr Yahello
Author-email: vyahello@gmail.com
License: UNKNOWN
Description: [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
        [![GitHub version](https://badge.fury.io/gh/vyahello%2Fsnakegame-cli.svg)](https://github.com/vyahello/snakegame-cli/releases)
        [![Build Status](https://travis-ci.org/vyahello/snakegame-cli.svg?branch=master)](https://travis-ci.org/vyahello/snakegame-cli)
        [![Coverage Status](https://img.shields.io/badge/coverage-56%25-orange)](https://img.shields.io/badge/coverage-56%25-orange)
        
        [![Forks](https://img.shields.io/github/forks/vyahello/snakegame-cli)](https://github.com/vyahello/snakegame-cli/network/members)
        [![Stars](https://img.shields.io/github/stars/vyahello/snakegame-cli)](https://github.com/vyahello/snakegame-cli/stargazers)
        [![GitHub watchers](https://img.shields.io/github/watchers/vyahello/snakegame-cli.svg)](https://GitHub.com/vyahello/snakegame-cli/graphs/watchers/)
        [![Issues](https://img.shields.io/github/issues/vyahello/snakegame-cli)](https://github.com/vyahello/snakegame-cli/issues)
        [![GitHub contributors](https://img.shields.io/github/contributors/vyahello/snakegame-cli.svg)](https://GitHub.com/vyahello/snakegame-cli/graphs/contributors/)
        
        [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
        [![License: GPL-3.0](https://img.shields.io/github/license/vyahello/snakegame-cli)](LICENSE.md)
        [![Hits-of-Code](https://hitsofcode.com/github/vyahello/snakegame-cli)](https://hitsofcode.com/view/github/vyahello/nakegame-cli)
        
        [![PyPI version shields.io](https://img.shields.io/pypi/v/cli-snakegame.svg)](https://pypi.python.org/pypi/cli-snakegame/)
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/cli-snakegame.svg)](https://pypi.python.org/pypi/cli-snakegame/)
        
        
        # Terminal snake game
        > A simple snake game right in your terminal using python built-in [curses](https://docs.python.org/3/howto/curses.html) package.
        > Just try it, it is fun :)
        
        ## Tools/features
         - python 3.4, 3.5, 3.6, 3.7, 3.8
         - curses
         - pytest
         - shell
         - travis CI
         - PYPI distributed
        
        ## Usage
        Please run following script to obtain latest package from PYPI:
        ```bash
        ➜ pip install cli-snakegame
        ```
        Then please execute instructions below to launch game from your environment:
        ```python
        from snake.game import SnakeGame
        
        game = SnakeGame()
        game.run()
        ...
        ```
        
        ## 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:
        ```bash
        ➜ ./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:
        ```bash
        ➜ pytest
        ```
        After please open `test-report.html` file to see detailed testing report
        
        ### Release notes
        
        * 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 vyahello@gmail.com
        
        Distributed under the `GNU` license. See [LICENSE](LICENSE.md) for more information.
        
        You can reach out me at:
        * [https://github.com/vyahello](https://github.com/vyahello)
        * [https://www.linkedin.com/in/volodymyr-yahello-821746127](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
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
