Example PR (feel free to use this as a template)

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = */tests/*

.gitignore

@@ -0,0 +1,110 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Pycharm project
+.idea/
+
+# VSCode project
+.vscode/

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+  - "3.6"
+
+# Command to run tests
+install:
+  - pip3 install -r requirements.txt
+script:
+  - python -m pytest --cov=src
+after_success:
+  - coveralls

ExamplePygame/Stars/class_enum.py

@@ -0,0 +1,42 @@
+class Enum:
+    """
+    A C++ like enum
+
+    :param args: a list of strings
+
+    :Example:
+
+        enum = Enum(
+            "splash",
+            "mainMenu",
+            "quit"
+        )
+
+        state = enum.splash
+
+        if state == enum.splash:
+            state = enum.mainMenu
+        else:
+            state = enum.quit
+
+        enum.print(state)
+    """
+
+    def __init__(self, *args):
+
+        self.__i = 0
+        self.__names = args
+
+        for name in args:
+            setattr(self, name, self.__i)
+            self.__i += 1
+
+    def print(self, i: int, **kwargs):
+        """
+        Print the name of the enum
+
+        :param i: the value of the Enum
+        :param kwargs: the common keyword arguments for the print function
+        """
+
+        print(self.__names[i], **kwargs)

ExamplePygame/Stars/class_star.py

@@ -0,0 +1,28 @@
+import pygame
+
+
+class Star(pygame.sprite.Sprite):
+    """
+    A shooting star
+
+    kwargs is used to define where the rect is placed
+    """
+
+    speed = 2
+    images = list()
+    screenRect = None
+
+    def __init__(self, **kwargs):
+        pygame.sprite.Sprite.__init__(self, self.containers)
+
+        self.image = self.images[0]
+        self.rect = self.image.get_rect(**kwargs)
+
+    def update(self):
+        """
+        Update the star at each iteration
+        """
+
+        self.rect.move_ip(self.speed, 0)
+        if not self.screenRect.contains(self.rect):
+            self.kill()

ExamplePygame/Stars/constants.py

@@ -0,0 +1,17 @@
+import os
+
+from class_enum import Enum
+
+
+DIRMAIN = os.path.dirname(__file__)
+DIRFILES = os.path.join(DIRMAIN, "files")
+DIRIMAGES = os.path.join(DIRMAIN, "images")
+DIRSOUNDS = os.path.join(DIRMAIN, "sounds")
+
+
+ENUM = Enum(
+    "splash",
+    "mainmenu",
+    "play",
+    "quit"
+)

ExamplePygame/Stars/func_images.py

@@ -0,0 +1,22 @@
+import os
+
+import pygame
+
+from constants import DIRIMAGES
+
+
+def load_image(filename: str) -> pygame.Surface:
+    """
+    Loads an image and prepares it
+
+    :param filename: the path to the image
+    :return: the image converted
+    """
+
+    try:
+        surface = pygame.image.load(os.path.join(DIRIMAGES, filename))
+    except pygame.error:
+        error = "Could not load image \"%s\" %s" % (filename, pygame.get_error())
+        raise SystemExit(error)
+
+    return surface.convert()

ExamplePygame/Stars/main.py

@@ -0,0 +1,77 @@
+import os
+import json
+
+import pygame
+from pygame.locals import *
+
+from constants import *
+from screen_splash import screen_splash
+from screen_mainmenu import screen_mainmenu
+from screen_play import screen_play
+
+
+class Main:
+    """
+    The main application
+    """
+
+    def __init__(self):
+
+        # Configuration
+        self.load_config()
+
+        # Init pygame
+        self.init_pygame()
+
+        # mainloop
+        self.mainloop()
+
+    def load_config(self):
+        """
+        Load the configuration file
+        """
+
+        fileConfig = os.path.join(DIRFILES, "config.json")
+        with open(fileConfig, "r", encoding="utf-8") as f:
+            self.config = json.load(f)
+
+    def init_pygame(self):
+        """
+        Intialize the main screen
+        """
+
+        size = self.config["screen"]["size"]
+        self.screenRect = Rect(0, 0, *size)
+
+        pygame.init()
+        pygame.font.init()
+
+        self.window = pygame.display.set_mode(self.screenRect.size)
+
+    def mainloop(self):
+        """
+        The mainloop the launch the game
+        """
+
+        state, param = screen_splash(self.window)
+
+        while state != ENUM.quit:
+
+            ENUM.print(state)
+
+            if state == ENUM.mainmenu:
+                state, param = screen_mainmenu(self.window, param)
+
+            elif state == ENUM.play:
+                param["config"] = self.config
+                param["screenRect"] = self.screenRect
+                state, param = screen_play(self.window, param)
+
+            else:
+                state = ENUM.quit
+
+        pygame.quit()
+
+
+if __name__ == '__main__':
+    Main()

ExamplePygame/Stars/screen_mainmenu.py

@@ -0,0 +1,37 @@
+import pygame
+from pygame.locals import *
+
+from constants import *
+
+
+def screen_mainmenu(window: pygame.Surface, param: dict = dict()) -> tuple:
+    """
+    The splash screen
+
+    :param window: The main window where to display the game
+    :param param: Some parameters from another screen
+    :return: The state of the next screen and a dict with some parameters
+    """
+
+    state = ENUM.mainmenu
+
+    font = pygame.font.SysFont('Comic Sans MS', 30)
+    textSurface = font.render('Main Menu', False, (0, 0, 0))
+
+    window.fill((0, 127, 127))
+    window.blit(textSurface, (0, 0))
+
+    while state == ENUM.mainmenu:
+
+        # Check for events
+        for event in pygame.event.get():
+            if event.type == QUIT:
+                state = ENUM.quit
+            elif (event.type == KEYDOWN and event.key == K_ESCAPE):
+                state = ENUM.quit
+            elif (event.type == KEYDOWN and event.key == K_RETURN):
+                state = ENUM.play
+
+        pygame.display.flip()
+
+    return state, dict()