libretro.py 0.0.0__tar.gz

libretro_py-0.0.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.0] - 2024-04-11
+
+### Added
+
+- Everything.

libretro_py-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jesse Talavera
+
+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.

libretro_py-0.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include CHANGELOG.md

libretro_py-0.0.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.1
+Name: libretro.py
+Version: 0.0.0
+Summary: A libretro frontend for Python intended for testing cores.
+Author-email: Jesse Talavera <jesse@jesse.tg>
+Maintainer-email: Jesse Talavera <jesse@jesse.tg>
+License: MIT License
+Project-URL: Homepage, https://github.com/JesseTG/libretro.py
+Project-URL: Issues, https://github.com/JesseTG/libretro.py/issues
+Project-URL: Repository, https://github.com/JesseTG/libretro.py
+Project-URL: Changelog, https://github.com/JesseTG/libretro.py/blob/master/CHANGELOG.md
+Keywords: libretro,retroarch,emulation,testing,retrogaming
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Environment :: Console :: Framebuffer
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing_extensions==4.*; python_version == "3.10"
+Provides-Extra: build
+Requires-Dist: build==1.2.1; extra == "build"
+Requires-Dist: setuptools>=69.1.1; extra == "build"
+Requires-Dist: twine==5.0.0; extra == "build"
+Provides-Extra: dev
+Requires-Dist: bandit==1.7.*; extra == "dev"
+Requires-Dist: black==23.*; extra == "dev"
+Requires-Dist: flake8==6.*; extra == "dev"
+Requires-Dist: isort==5.*; extra == "dev"
+Requires-Dist: mypy==1.5.*; extra == "dev"
+Requires-Dist: libretro.py[build]; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: Sphinx==7.*; extra == "docs"
+Requires-Dist: sphinx-autobuild==2024.*; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Provides-Extra: doc
+Requires-Dist: libretro.py[docs]; extra == "doc"
+Provides-Extra: opengl
+Requires-Dist: moderngl==5.10.*; extra == "opengl"
+Provides-Extra: pillow
+Requires-Dist: pillow==10.2.*; extra == "pillow"
+Requires-Dist: types-Pillow; extra == "pillow"
+Provides-Extra: all
+Requires-Dist: libretro.py[build,dev,docs,opengl,pillow]; extra == "all"
+
+# libretro.py
+
+A Python binding for [libretro][libretro] intended for testing cores,
+but suitable for any purpose.
+Ease of use, flexibility, and complete API support are top priorities.
+
+<div align="center">
+
+[![Build Status](https://github.com/JesseTG/libretro.py/workflows/build/badge.svg)](https://github.com/JesseTG/libretro.py/actions)
+[![PyPi](https://img.shields.io/pypi/v/PROJECT_NAME_URL)](https://pypi.org/project/PROJECT_NAME_URL)
+[![License](https://img.shields.io/github/license/JesseTG/libretro.py)](LICENSE)
+
+</div>
+
+# Supported Environments
+
+libretro.py has the following requirements:
+
+- Python 3.10 or newer.
+  May not work on alternative Python implementations like PyPy.
+- Supported on Windows, macOS, and Linux.
+  May work on other platforms, but no promises.
+
+Nothing else is required for most functionality,
+but some [extra features](#extras) have additional dependencies or constraints.
+
+If contributing then [`just`][just] is optional but recommended,
+as it will simplify most development tasks.
+For details, run `just` (no arguments) in the project root.
+
+# Installing
+
+libretro.py supports **Python 3.10 or newer**.
+Nothing else is required for most functionality,
+but some extra features have additional dependencies.
+
+You can install libretro.py with `pip` like so:
+
+```bash
+# Install the base libretro.py
+pip install libretro.py
+```
+
+Using a virtual environment is recommended:
+
+```bash
+# Create a virtual environment
+python -m venv ./venv
+
+# Activate the virtual environment (in Bash)
+source ./venv/bin/activate
+
+# Activate the virtual environment (in PowerShell)
+./venv/Scripts/activate.ps1 
+```
+
+Or if you have [`just`][just] installed, let it figure out the details for you:
+
+```bash
+just venv
+```
+
+## Extras
+
+To install additional features,
+add one or more of the following extras to the `install` command:
+
+- **`dev`:** Assorted tools used to help develop libretro.py.
+  Required if contributing to libretro.py.
+- **`opengl`:** Support for the built-in OpenGL video driver.
+  Required if testing a core's OpenGL support.
+- **`pillow`:** Support for the built-in software-only video driver
+  powered by the [Pillow][pillow] image processing library.
+  Not required for any particular feature,
+  but it simplifies tests that inspect the core's video output.
+
+For example, if you want to submit an improvement to the Pillow video driver,
+you would install libretro.py like so:
+
+```bash
+pip install libretro.py[pillow,dev]
+```
+
+And if you just want to test your libretro core's OpenGL support:
+
+```bash
+pip install libretro.py[opengl]
+```
+
+[just]: https://just.systems
+[libretro]: https://www.libretro.com
+[pillow]: https://python-pillow.org

libretro_py-0.0.0/README.md

@@ -0,0 +1,92 @@
+# libretro.py
+
+A Python binding for [libretro][libretro] intended for testing cores,
+but suitable for any purpose.
+Ease of use, flexibility, and complete API support are top priorities.
+
+<div align="center">
+
+[![Build Status](https://github.com/JesseTG/libretro.py/workflows/build/badge.svg)](https://github.com/JesseTG/libretro.py/actions)
+[![PyPi](https://img.shields.io/pypi/v/PROJECT_NAME_URL)](https://pypi.org/project/PROJECT_NAME_URL)
+[![License](https://img.shields.io/github/license/JesseTG/libretro.py)](LICENSE)
+
+</div>
+
+# Supported Environments
+
+libretro.py has the following requirements:
+
+- Python 3.10 or newer.
+  May not work on alternative Python implementations like PyPy.
+- Supported on Windows, macOS, and Linux.
+  May work on other platforms, but no promises.
+
+Nothing else is required for most functionality,
+but some [extra features](#extras) have additional dependencies or constraints.
+
+If contributing then [`just`][just] is optional but recommended,
+as it will simplify most development tasks.
+For details, run `just` (no arguments) in the project root.
+
+# Installing
+
+libretro.py supports **Python 3.10 or newer**.
+Nothing else is required for most functionality,
+but some extra features have additional dependencies.
+
+You can install libretro.py with `pip` like so:
+
+```bash
+# Install the base libretro.py
+pip install libretro.py
+```
+
+Using a virtual environment is recommended:
+
+```bash
+# Create a virtual environment
+python -m venv ./venv
+
+# Activate the virtual environment (in Bash)
+source ./venv/bin/activate
+
+# Activate the virtual environment (in PowerShell)
+./venv/Scripts/activate.ps1 
+```
+
+Or if you have [`just`][just] installed, let it figure out the details for you:
+
+```bash
+just venv
+```
+
+## Extras
+
+To install additional features,
+add one or more of the following extras to the `install` command:
+
+- **`dev`:** Assorted tools used to help develop libretro.py.
+  Required if contributing to libretro.py.
+- **`opengl`:** Support for the built-in OpenGL video driver.
+  Required if testing a core's OpenGL support.
+- **`pillow`:** Support for the built-in software-only video driver
+  powered by the [Pillow][pillow] image processing library.
+  Not required for any particular feature,
+  but it simplifies tests that inspect the core's video output.
+
+For example, if you want to submit an improvement to the Pillow video driver,
+you would install libretro.py like so:
+
+```bash
+pip install libretro.py[pillow,dev]
+```
+
+And if you just want to test your libretro core's OpenGL support:
+
+```bash
+pip install libretro.py[opengl]
+```
+
+[just]: https://just.systems
+[libretro]: https://www.libretro.com
+[pillow]: https://python-pillow.org

libretro_py-0.0.0/pyproject.toml

@@ -0,0 +1,92 @@
+[project]
+name = "libretro.py"
+dynamic = ["version"]
+description = "A libretro frontend for Python intended for testing cores."
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT License"}
+authors = [
+    {name = "Jesse Talavera", email = "jesse@jesse.tg"},
+]
+maintainers = [
+    {name = "Jesse Talavera", email = "jesse@jesse.tg"},
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Environment :: Console :: Framebuffer",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: C",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Games/Entertainment",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Testing",
+]
+keywords = ["libretro", "retroarch", "emulation", "testing", "retrogaming"]
+dependencies = [
+    "typing_extensions == 4.*; python_version == '3.10'",
+]
+
+[project.optional-dependencies]
+build = [
+    'build == 1.2.1',
+    'setuptools>=69.1.1',
+    'twine == 5.0.0',
+]
+dev = [
+    'bandit == 1.7.*',
+    'black == 23.*',
+    'flake8 == 6.*',
+    'isort == 5.*',
+    'mypy == 1.5.*',
+    "libretro.py[build]"
+]
+docs = [
+    'Sphinx == 7.*',
+    'sphinx-autobuild == 2024.*',
+    'furo',
+]
+doc = ["libretro.py[docs]"] # Alias for the docs extra
+opengl = [
+    'moderngl == 5.10.*',
+]
+pillow = [
+    'pillow == 10.2.*',
+    'types-Pillow',
+]
+all = ["libretro.py[build,dev,docs,opengl,pillow]"]
+
+[project.urls]
+Homepage = "https://github.com/JesseTG/libretro.py"
+Issues = "https://github.com/JesseTG/libretro.py/issues"
+Repository = "https://github.com/JesseTG/libretro.py"
+Changelog = "https://github.com/JesseTG/libretro.py/blob/master/CHANGELOG.md"
+
+[build-system]
+requires = [
+    'build == 1.2.1',
+    'setuptools>=69.1.1',
+    'twine == 5.0.0',
+]
+build-backend = "setuptools.build_meta"
+
+
+
+
+[tool.black]
+line-length = 99
+
+[tool.bandit]
+# Don't flag asserts
+skips = ["B101"]
+
+[tool.isort]
+profile = "black"

libretro_py-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

libretro_py-0.0.0/setup.py

@@ -0,0 +1,16 @@
+from os.path import join, dirname
+import re
+import setuptools
+
+with open(join(dirname(__file__), "CHANGELOG.md"), "r") as file:
+    changelog = file.read()
+
+    # We fetch the version number from CHANGELOG.md
+    # so that we don't have to maintain it in multiple places.
+    match = re.search(r"## \[(?P<version>\d+\.\d+\.\d+)]", changelog, re.MULTILINE)
+    if not match:
+        raise ValueError("Could not find the latest version in CHANGELOG.md")
+
+    version = match["version"]
+
+setuptools.setup(version=version)

libretro_py-0.0.0/src/libretro/__init__.py

@@ -0,0 +1,6 @@
+from .api import *
+from .builder import *
+from .core import *
+from .drivers import *
+from .error import *
+from .session import *