python-opengl-framework

UPDATE 2022-12-19: This project is on stand-by. PyOpenGL is a good but old library and it hasn't been mantained in a long time. I'he to decide if migrate the project to use ModernGL or just use Ursina Engine.

This is an implementation of an OpenGL Graphics Framework with Python for educational purposes. For the implementation we only need this four libraries:

• PyGame
• PyOpenGL
• PyOpenGL-accelerate
• Numpy

All the modules and scripts are conformed to PEP8 style guide by using

• flake8
• Mypy
• isort
• Black

Index

• sandbox: This folder contains the test scripts that are implemented in the book to learn and test the framework.
• exercises: This folder contains exercises proposed for each chapter.
• core: This folder contains the core of the framework.
• License GNU General Public License v3.0

Notes:

• The code is based in the book: * Developing Graphics Frameworks with Python and OpenGL. by Lee Stemkoski and Michael Pascale.
• Project's structure is based on the one proposed in the book, but with emphasis in applying pythonic 🐍 style, code coverage and, and usability.
• The code is not fully tested. Please report any issue you find.
• Some classes and functions has been modified to improve performance and/or usability.
• Repo's history has comments with references to the book's pages.
• The file openGLUtils.py has been refactored to opengl_utils.py.
• Functions and variables in the book are refactored from camelCase to snake_case.
• Added a settings file to configure the framework.

Requirements for the project

• numpy==1.23.3
• pygame==2.1.2
• PyOpenGL==3.1.6
• PyOpenGL-accelerate==3.1.6

Required for code coverage/quality/formating

• aiohttp==3.8.1
• aiosignal==1.2.0
• astroid==2.12.10
• async-timeout==4.0.2
• attrs==22.1.0
• black==22.8.0
• charset-normalizer==2.1.1
• click==8.1.3
• colorama==0.4.5
• dill==0.3.5.1
• flake8==5.0.4
• frozenlist==1.3.1
• idna==3.4
• isort==5.10.1
• lazy-object-proxy==1.7.1
• mccabe==0.7.0
• multidict==6.0.2
• mypy==0.971
• mypy-extensions==0.4.3
• pathspec==0.10.1
• platformdirs==2.5.2
• pycodestyle==2.9.1
• pyflakes==2.5.0
• pylint==2.15.3
• tomli==2.0.1
• tomlkit==0.11.4
• typing_extensions==4.3.0
• wrapt==1.14.1
• yarl==1.8.1

My system

• Windows 11 / Ubuntu 20.04
• Python 3.10.4
• PyCharm 2021.3.2 (Community Edition)
• Renderer: GeForce GTX 1070 with Max-Q Design/PCIe/SSE2
• OpenGL version: 4.6.0 NVIDIA 457.63
• GLSL version: 4.60 NVIDIA

TODO:

• Add settings.py
• Add some screenshots
• Add TOX
• Add Black
• Add flake8
• Add isort
• Add mypy
• Add unittests
• Add setup.py