Metadata-Version: 2.1
Name: pygame-menu
Version: 3.5.1
Summary: A menu for pygame, simple, lightweight and easy to use
Home-page: https://pygame-menu.readthedocs.io/en/latest/
Author: ppizarror
Author-email: pablo@ppizarror.com
License: MIT
Project-URL: Bug Tracker, https://github.com/ppizarror/pygame-menu/issues
Project-URL: Documentation, https://pygame-menu.readthedocs.io/en/latest/
Project-URL: Source Code, https://github.com/ppizarror/pygame-menu/tree/master/pygame_menu
Keywords: pygame menu menus gui widget input button pygame-menu
Platform: any
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Multimedia
Classifier: Topic :: Software Development :: Libraries :: pygame
Classifier: Topic :: Text Processing
Requires-Python: >=2.7, <4
Requires-Dist: pygame (>=1.9.3)
Requires-Dist: pyperclip
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'


===========
pygame-menu
===========

.. image:: docs/_static/pygame_menu_small.png
    :align: center
    :alt:

.. image:: https://img.shields.io/badge/author-Pablo%20Pizarro%20R.-lightgray.svg
    :target: https://ppizarror.com
    :alt: @ppizarror

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://opensource.org/licenses/MIT
    :alt: License MIT

.. image:: https://img.shields.io/badge/python-2.7+ / 3.5+-red.svg
    :target: https://www.python.org/downloads
    :alt: Python 2.7+/3.5+

.. image:: https://img.shields.io/badge/pygame-1.9%2B%2F2.0%2B-orange
    :target: https://www.pygame.org
    :alt: Pygame 1.9+/2.0+

.. image:: https://badge.fury.io/py/pygame-menu.svg
    :target: https://pypi.org/project/pygame-menu
    :alt: PyPi package

.. image:: https://travis-ci.com/ppizarror/pygame-menu.svg?branch=master
    :target: https://travis-ci.com/ppizarror/pygame-menu
    :alt: Travis

.. image:: https://img.shields.io/lgtm/alerts/g/ppizarror/pygame-menu.svg?logo=lgtm&logoWidth=18
    :target: https://lgtm.com/projects/g/ppizarror/pygame-menu/alerts
    :alt: Total alerts

.. image:: https://img.shields.io/lgtm/grade/python/g/ppizarror/pygame-menu.svg?logo=lgtm&logoWidth=18
    :target: https://lgtm.com/projects/g/ppizarror/pygame-menu/context:python
    :alt: Language grade: Python

.. image:: https://codecov.io/gh/ppizarror/pygame-menu/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/ppizarror/pygame-menu
    :alt: Codecov

.. image:: https://img.shields.io/github/issues/ppizarror/pygame-menu
    :target: https://github.com/ppizarror/pygame-menu/issues
    :alt: Open issues

.. image:: https://img.shields.io/pypi/dm/pygame-menu?color=purple
    :target: https://pypi.org/project/pygame-menu/
    :alt: PyPi downloads

Source repo on `GitHub <https://github.com/ppizarror/pygame-menu>`_, 
and run it on `Repl.it <https://repl.it/github/ppizarror/pygame-menu>`_

Introduction
------------

Pygame-menu is a python-pygame library for creating menus. It supports
selectors, buttons, labels, color inputs, and text inputs, with many options to customize.

Comprehensive documentation for the latest version is available at
https://pygame-menu.readthedocs.io. For pygame-menu `v2`, check out
https://github.com/ppizarror/pygame-menu/blob/v2/README.md

**NOTE:** pygame-menu `v3` will not provide new widgets or functionalities, consider
upgrading to the latest version.

Install Instructions
--------------------

Pygame-menu can be installed via pip. Simply run::

    $> pip install pygame-menu

To build the documentation from a Git repository:

.. code-block:: bash

    $> clone https://github.com/ppizarror/pygame-menu
    $> cd pygame-menu
    $> pip install -e .[doc]
    $> cd docs
    $> make html


