Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rhenter/battleship-python

This is a simple, but super cool Battleship game. Lets Play!!!
https://github.com/rhenter/battleship-python

Last synced: 28 days ago
JSON representation

This is a simple, but super cool Battleship game. Lets Play!!!

Awesome Lists containing this project

README

        

=================
Battleship Python
=================

|PyPI latest| |PyPI Version| |PyPI License| |CicleCI Status| |Coverage|

This is a simple Framework of Battleship game. Lets Play!!!

Installation
------------

.. code-block:: bash

$ pip install py-battleship

Or, you can download the source and

.. code-block:: bash

$ git clone [email protected]:rhenter/battleship-python.git
$ cd battleship-python
$ python setup.py install

Add sudo in the beginning if you met problem.

How to Use
----------

To play use:

.. code-block:: bash

$ py-battleship

or

.. code-block:: bash

$ python -m battlefield

.. image:: https://raw.githubusercontent.com/rhenter/battleship-python/master/game.png
:width: 600

Documentation
-------------

In progress

Contributing
------------

Please send pull requests, very much appreciated.

1. Fork the `repository `_ on GitHub.
2. Make a branch off of master and commit your changes to it.
3. Install requirements. ``pip install -r requirements-dev.txt``
4. Install pre-commit. ``pre-commit install``
5. Create a Pull Request with your contribution

.. |PyPI Version| image:: https://img.shields.io/pypi/pyversions/py-battleship.svg?maxAge=360
:target: https://pypi.python.org/pypi/py-battleship
.. |PyPI License| image:: https://img.shields.io/pypi/l/py-battleship.svg?maxAge=360
:target: https://github.com/rhenter/battleship-python/blob/master/LICENSE
.. |PyPI latest| image:: https://img.shields.io/pypi/v/py-battleship.svg?maxAge=360
:target: https://pypi.python.org/pypi/py-battleship
.. |CicleCI Status| image:: https://circleci.com/gh/rhenter/battleship-python.svg?style=svg
:target: https://circleci.com/gh/rhenter/battleship-python
.. |Coverage| image:: https://codecov.io/gh/rhenter/battleship-python/branch/master/graph/badge.svg
:target: https://codecov.io/gh/rhenter/battleship-python