README.md

# python-snake

python-snake is a side project I developped in order to practice Python


## Installation

the project is using specific dependencies other than the basic python module

I developped it using Python 3.8.2

**clone the repo with**

```
git clone https://gitlab.anthony-jacob.com/anthony.jacob/python-snake.git
```

**create a Python virtual environment**

```
cd python-snake
python -m venv venv
```

**activate the Virtual environment**

with Windows command:
`venv\Scripts\activate.bat`

with powershell:
`venv/bin/Activate.ps1`

with bash:
`source <venv>/bin/activate`

**install the dependencies**

`pip install -r requirements.txt`

**run**

`python main.py`

## Play

there is a intermediary menu where you can exit or choose the play (only in terminal for now)

to move the snake you can use the keyboard arrow 

### Customize the grid size

right know if the grid does not fit your terminal, you can change the size 
by editing the file **_pythonsnake/controller.py_** at line **33**

`        self.game = Game(50, 25)`


## Limitation

it is far from perfect but it is good enough to try 
this project is a proof of concept, some part could be improve
the refresh of the screen is blinking and the event listener for the control are not responsive all the time