pykemon_battle 0.0.3

A command-line Pokemon battling system

A text-based Pokémon battling system

Table of Contents

1. About The Project
2. Installation
3. Usage
4. Tests
5. Roadmap
6. License
7. Contributing
8. Contact

About The Project

pykemmon_battle is a library that provides a text-based Pokémon battling system.

Installation

Quick installation instructions:

$ python -m pip install pykemon_battle

Install a development version of this library by cloning the repository and running flit:

$ git clone https://github.com/11michalis11/pykemon_battle.git
$ cd pykemon_battle
$ python -m pip install flit
$ python -m flit install --symlink

Usage

Include the following in a python script:

import pykemon_battle as pkm

team_size = 3
new_battle = pkm.Battle(team_size)
new_battle.start_battle()

Then run the script in your terminal:

$ python my_script.py

Tests

Run all tests developed by first installing and then running tox:

$ python -m pip install tox
$ python -m tox

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contributing

1. Fork the repository
2. Clone the forked repository
3. Create a new branch
4. Apply changes to the pykemon_battle library
5. Run tests and make sure they pass
6. Commit changes
7. Push changes to GitHub
8. Open PR on GitHub

Contact

Michalis Panayides - @Michalis_Pan - [e-mail]

Project Link: pykemon_battle