Welcome to snake’s documentation!

Snake on Terminal

A simple snake game on terminal with focus on well design, reuse and best practise.

Asciimatics engine, redraws terminal.

Basic engine, uses normal prints.

Usage

Play with snake

# run the game with defaults
snake

# or with custom options
snake --rows-no 40 --cols-no 80 --speed 5 --initial-length 8

For list of options and documentation run

snake --help  # shows the options list and some docs.

Installation

Install with pip

pip3 install snake-terminal-pp

Install with git

git clone https://github.com/lparolari/snake
cd snake
python3 setup.py install

Author

• Luca Parolari <luca.parolari23@gmail.com>

License

This software is MIT Licensed. See LICENSE file.

Installation

Stable release

To install snake, run this command in your terminal:

$ pip install snake

This is the preferred method to install snake, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for snake can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/lparolari/snake

Or download the tarball:

$ curl -OJL https://github.com/lparolari/snake/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use snake in a project:

import snake

snake

snake package

Submodules

snake.board module

snake.broadcaster module

class snake.broadcaster.Broadcaster

Bases: object

event(e, *args)

listen(to, callback)

snake.cli module

snake.engine module

snake.food module

snake.game module

snake.keyb module

snake.snaky module

snake.util module

snake.util.wasd_to_direction(wasd)

Module contents

Top-level package for snake.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/lparolari/snake/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

snake could always use more documentation, whether as part of the official snake docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/lparolari/snake/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up snake for local development.

1. Fork the snake repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/snake.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv snake
   $ cd snake/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 snake tests
   $ python setup.py test or pytest
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.5, 3.6 and 3.7, and for PyPy. Check https://travis-ci.org/lparolari/snake/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_snake

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

• Luca Parolari <luca.parolari23@gmail.com>

Contributors

None yet. Why not be the first?

History

0.1.0 (2019-09-12)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page