Metadata-Version: 2.1
Name: python-pong
Version: 1.0.0
Summary: A Python library containing components and implementations of the game Pong for Pygame
Author: Dyrektrypt
License: MIT License
        
        Copyright (c) 2023 Dyrektrypt
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/Dyrektrypt/python-pong
Project-URL: Homepage, https://github.com/Dyrektrypt/python-pong#readme
Project-URL: Bug Tracker, https://github.com/Dyrektrypt/python-pong/issues
Description-Content-Type: text/markdown
License-File: LICENSE

# python-pong
python-pong is a simple, open-source Python library for quickly setting up components and games of Pong in Pygame.

## Installation
python-pong can be installed from PyPI using pip. Simply run the command `python -m pip install python-pong`
globally, or in your virtual Python project environment, where `python` is your current Python distribution.

## Usage
python-pong makes usage of multiple packages containing modules and classes that can be easily incorporated into a
Pygame Python project to assist the development of a custom game of Pong.

>### pong.components 
> The pong.components package contains only classes that implement individual components that can be
used within a game of Pong. Each component should be attached to a pygame.Surface object during instantiation.
> ### pong.game
> The pong.game package contains only classes that implement configurable
games of Pong in Pygame. These classes might require additional dependencies such as Tkinter within the Python standard library.
> ### pong.utility
> The pong.utility package contains modules that provide useful global constants, classes and functions for
development of a game of Pong in Pygame.

An example of the python-pong library being used to create a basic game of Pong is shown in the following:

```python
from pong.game.Basic import Basic


def main():
    # create a pre-configured instance of a basic Pong game
    Basic()

    
if __name__ == "__main__":
    main()
```
