arcade 3.0.0.dev29__tar.gz → 3.0.0.dev31__tar.gz

arcade-3.0.0.dev31/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: arcade
+Version: 3.0.0.dev31
+Summary: Arcade Game Development Library
+Author-email: Paul Vincent Craven <paul@cravenfamily.com>
+License: License
+        =======
+        
+        Copyright (c) 2022 Paul Vincent Craven
+        
+        The Arcade library is licensed under the `MIT License`_.
+        
+        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.
+        
+        .. _MIT License: https://tldrlegal.com/license/mit-license
+Project-URL: Homepage, https://api.arcade.academy
+Project-URL: Documentation, https://api.arcade.academy/
+Project-URL: Examples, https://api.arcade.academy/en/latest/examples/index.html
+Project-URL: Issues, https://github.com/pythonarcade/arcade/issues
+Project-URL: Source, https://github.com/pythonarcade/arcade
+Project-URL: Book, https://learn.arcade.academy
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pyglet==2.1.dev4
+Requires-Dist: pillow~=10.2.0
+Requires-Dist: pymunk~=6.6.0
+Requires-Dist: pytiled-parser~=2.2.5
+Provides-Extra: dev
+Requires-Dist: sphinx==7.3.7; extra == "dev"
+Requires-Dist: sphinx_rtd_theme==2.0.0; extra == "dev"
+Requires-Dist: sphinx-rtd-dark-mode==1.3.0; extra == "dev"
+Requires-Dist: sphinx-autobuild==2024.4.16; extra == "dev"
+Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
+Requires-Dist: sphinx-sitemap==2.6.0; extra == "dev"
+Requires-Dist: pygments==2.17.2; extra == "dev"
+Requires-Dist: docutils==0.20.1; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: coveralls; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pyright==1.1.372; extra == "dev"
+Requires-Dist: typer[all]==0.11.0; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Provides-Extra: testing-libraries
+Requires-Dist: pytest; extra == "testing-libraries"
+Requires-Dist: pytest-mock; extra == "testing-libraries"
+Requires-Dist: pytest-cov; extra == "testing-libraries"
+Requires-Dist: pyyaml==6.0.1; extra == "testing-libraries"
+
+# Welcome to The Arcade Library!
+
+![MIT License](https://img.shields.io/pypi/l/arcade)
+[<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="Pull Requests Welcome">](http://makeapullrequest.com)
+[<img src="https://img.shields.io/badge/first--timers--only-friendly-blue.svg" alt="First Timers Friendly">](http://www.firsttimersonly.com/)
+
+Arcade is an easy-to-learn Python library for creating 2D video games.
+It is ideal for beginning programmers, or programmers who want to create
+2D games without learning a complex framework.
+
+[pyglet]: https://github.com/pyglet/pyglet
+[Games Made with Arcade]: https://api.arcade.academy/en/latest/sample_games.html
+Arcade is built on top of [pyglet][] and OpenGL. See [Games Made with Arcade][]
+for example game jam entries and more.
+
+[Arcade Discord Server]: https://discord.gg/ZjGDqMp
+
+![PyPI - Downloads](https://img.shields.io/pypi/dm/arcade)
+![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/pythonarcade/arcade)
+
+## Stable Documentation
+
+Read the stable documentation at https://api.arcade.academy.
+
+## Development Previews
+
+Preview the next release at https://api.arcade.academy/en/development/.
+
+## Citation
+
+```
+    @Online{PythonArcade,
+       author = {Paul Vincent Craven},
+       title = {Easy to use Python library for creating 2D arcade games.},
+       date = {2023-01-01},
+       publisher = {GitHub},
+       journal = {GitHub repository},
+       howpublished = {\url{https://github.com/pythonarcade/arcade}},
+       commit = {<insert hash if needed>}
+    }
+```
+
+## Contact the Maintainers
+
+The best way to contact and chat with the maintainers is on the
+[Arcade Discord Server][].
+
+paul@cravenfamily.com

arcade-3.0.0.dev31/README.md

@@ -0,0 +1,48 @@
+# Welcome to The Arcade Library!
+
+![MIT License](https://img.shields.io/pypi/l/arcade)
+[<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="Pull Requests Welcome">](http://makeapullrequest.com)
+[<img src="https://img.shields.io/badge/first--timers--only-friendly-blue.svg" alt="First Timers Friendly">](http://www.firsttimersonly.com/)
+
+Arcade is an easy-to-learn Python library for creating 2D video games.
+It is ideal for beginning programmers, or programmers who want to create
+2D games without learning a complex framework.
+
+[pyglet]: https://github.com/pyglet/pyglet
+[Games Made with Arcade]: https://api.arcade.academy/en/latest/sample_games.html
+Arcade is built on top of [pyglet][] and OpenGL. See [Games Made with Arcade][]
+for example game jam entries and more.
+
+[Arcade Discord Server]: https://discord.gg/ZjGDqMp
+
+![PyPI - Downloads](https://img.shields.io/pypi/dm/arcade)
+![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/pythonarcade/arcade)
+
+## Stable Documentation
+
+Read the stable documentation at https://api.arcade.academy.
+
+## Development Previews
+
+Preview the next release at https://api.arcade.academy/en/development/.
+
+## Citation
+
+```
+    @Online{PythonArcade,
+       author = {Paul Vincent Craven},
+       title = {Easy to use Python library for creating 2D arcade games.},
+       date = {2023-01-01},
+       publisher = {GitHub},
+       journal = {GitHub repository},
+       howpublished = {\url{https://github.com/pythonarcade/arcade}},
+       commit = {<insert hash if needed>}
+    }
+```
+
+## Contact the Maintainers
+
+The best way to contact and chat with the maintainers is on the
+[Arcade Discord Server][].
+
+paul@cravenfamily.com

arcade-3.0.0.dev31/arcade/VERSION

@@ -0,0 +1 @@
+3.0.0-dev.31

arcade-3.0.0.dev31/arcade/__init__.py

@@ -0,0 +1,410 @@
+"""
+The Arcade Library
+
+A Python simple, easy to use module for creating 2D games.
+"""
+
+from __future__ import annotations
+
+# flake8: noqa: E402
+# Error out if we import Arcade with an incompatible version of Python.
+import sys
+import os
+from typing import Final
+
+from pathlib import Path
+
+if sys.version_info[0] < 3 or (sys.version_info[0] == 3 and sys.version_info[1] < 9):
+    sys.exit("The Arcade Library requires Python 3.9 or higher.")
+
+
+def configure_logging(level: int | None = None):
+    """Set up basic logging.
+    :param level: The log level. Defaults to DEBUG.
+    """
+    import logging
+
+    level = level or logging.DEBUG
+    LOG = logging.getLogger(__name__)
+    # Do not add a new handler if we already have one
+    if not LOG.handlers:
+        LOG.propagate = False
+        LOG.setLevel(level)
+        ch = logging.StreamHandler()
+        ch.setLevel(level)
+        ch.setFormatter(
+            logging.Formatter("%(relativeCreated)s %(name)s %(levelname)s - %(message)s")
+        )
+        LOG.addHandler(ch)
+
+
+# The following is used to load ffmpeg libraries.
+# Currently Arcade is only shipping binaries for Mac OS
+# as ffmpeg is not needed for support on Windows and Linux.
+# However it is setup to load ffmpeg if the binaries are present
+# on Windows and Linux. So if you need ffmpeg you can simply
+# drop the binaries in the "lib" folder of Arcade
+lib_location = Path(__file__).parent.absolute()
+lib_location = lib_location / "lib"
+
+if sys.platform == "darwin" or sys.platform.startswith("linux"):
+    if "LD_LIBRARY_PATH" in os.environ:
+        os.environ["LD_LIBRARY_PATH"] += ":" + str(lib_location)
+    else:
+        os.environ["LD_LIBRARY_PATH"] = str(lib_location)
+else:
+    os.environ["PATH"] += str(lib_location)
+
+# noinspection PyPep8
+import pyglet
+
+
+# Env variable shortcut for headless mode
+headless: Final[bool] = bool(os.environ.get("ARCADE_HEADLESS"))
+if headless:
+    pyglet.options.headless = headless  # type: ignore # pending https://github.com/pyglet/pyglet/issues/1164
+
+
+from arcade import utils
+
+# Disable shadow window on macs and in headless mode.
+if sys.platform == "darwin" or os.environ.get("ARCADE_HEADLESS") or utils.is_raspberry_pi():
+    pyglet.options.shadow_window = False  # type: ignore # pending https://github.com/pyglet/pyglet/issues/1164
+
+# Use the old gdi fonts on windows until directwrite is fast/stable
+# pyglet.options.win32_gdi_font = True
+
+# Imports from modules that don't do anything circular
+
+# Complex imports with potential circularity
+from .window_commands import close_window
+from .window_commands import exit
+from .window_commands import finish_render
+from .window_commands import get_display_size
+from .window_commands import get_window
+from .window_commands import schedule
+from .window_commands import run
+from .window_commands import set_background_color
+from .window_commands import set_window
+from .window_commands import start_render
+from .window_commands import unschedule
+from .window_commands import schedule_once
+
+from .sections import Section, SectionManager
+
+from .application import MOUSE_BUTTON_LEFT
+from .application import MOUSE_BUTTON_MIDDLE
+from .application import MOUSE_BUTTON_RIGHT
+from .application import NoOpenGLException
+from .application import View
+from .application import Window
+from .application import get_screens
+from .application import open_window
+
+from .texture import Texture
+from .texture import TextureCacheManager
+from .texture import SpriteSheet
+from .texture import load_spritesheet
+from .texture import load_texture
+from .texture import load_image
+from .texture import make_circle_texture
+from .texture import make_soft_circle_texture
+from .texture import make_soft_square_texture
+from .texture import get_default_image
+from .texture import get_default_texture
+
+from .draw import get_points_for_thick_line
+from .draw import draw_arc_filled
+from .draw import draw_arc_outline
+from .draw import draw_circle_filled
+from .draw import draw_circle_outline
+from .draw import draw_ellipse_filled
+from .draw import draw_ellipse_outline
+from .draw import draw_line
+from .draw import draw_line_strip
+from .draw import draw_lines
+from .draw import draw_lrbt_rectangle_filled
+from .draw import draw_lrbt_rectangle_outline
+from .draw import draw_parabola_filled
+from .draw import draw_parabola_outline
+from .draw import draw_point
+from .draw import draw_points
+from .draw import draw_polygon_filled
+from .draw import draw_polygon_outline
+from .draw import draw_rect_filled
+from .draw import draw_rect_outline
+from .draw import draw_texture_rect
+from .draw import draw_sprite
+from .draw import draw_sprite_rect
+from .draw import draw_triangle_filled
+from .draw import draw_triangle_outline
+from .draw import draw_lbwh_rectangle_filled
+from .draw import draw_lbwh_rectangle_outline
+from .screenshot import get_image
+from .screenshot import get_pixel
+
+# We don't have joysticks game controllers in headless mode
+if not headless:  # type: ignore
+    from .joysticks import get_game_controllers
+    from .joysticks import get_joysticks
+    from .controller import ControllerManager
+    from .controller import get_controllers
+
+from .sound import Sound
+from .sound import load_sound
+from .sound import play_sound
+from .sound import stop_sound
+
+from .sprite import FACE_DOWN
+from .sprite import FACE_LEFT
+from .sprite import FACE_RIGHT
+from .sprite import FACE_UP
+from .sprite import TextureAnimationSprite
+from .sprite import load_animated_gif
+from .sprite import AnimatedWalkingSprite
+from .sprite import TextureAnimation
+from .sprite import TextureKeyframe
+from .sprite import PyMunk
+from .sprite import PymunkMixin
+from .sprite import SpriteType
+from .sprite import Sprite
+from .sprite import BasicSprite
+
+# from .sprite import SimpleSprite
+from .sprite import SpriteCircle
+from .sprite import SpriteSolidColor
+
+from .sprite_list import SpriteList
+from .sprite_list import check_for_collision
+from .sprite_list import check_for_collision_with_list
+from .sprite_list import check_for_collision_with_lists
+from .sprite_list import get_closest_sprite
+from .sprite_list import get_sprites_at_exact_point
+from .sprite_list import get_sprites_at_point
+from .sprite_list import get_distance_between_sprites
+from .sprite_list import get_sprites_in_rect
+
+from .sprite_list import SpatialHash
+
+from .scene import Scene
+from .scene import SceneKeyError
+
+from .physics_engines import PhysicsEnginePlatformer
+from .physics_engines import PhysicsEngineSimple
+
+from .tilemap import load_tilemap
+from .tilemap import read_tmx
+from .tilemap import TileMap
+
+from .pymunk_physics_engine import PymunkPhysicsEngine
+from .pymunk_physics_engine import PymunkPhysicsObject
+from .pymunk_physics_engine import PymunkException
+
+from .version import VERSION
+
+from .paths import has_line_of_sight
+from .paths import AStarBarrierList
+from .paths import astar_calculate_path
+
+from .context import ArcadeContext
+
+from .texture_atlas import DefaultTextureAtlas
+
+from .perf_info import enable_timings
+from .perf_info import print_timings
+from .perf_info import get_fps
+from .perf_info import get_timings
+from .perf_info import clear_timings
+from .perf_info import timings_enabled
+from .perf_info import disable_timings
+
+from .perf_graph import PerfGraph
+
+from .camera import Camera2D
+
+from .types.rect import Rect, LRBT, LBWH, XYWH
+
+# Module imports
+from arcade import color as color
+from arcade import csscolor as csscolor
+from arcade import camera as camera
+from arcade import key as key
+from arcade import resources as resources
+from arcade import types as types
+from arcade import math as math
+from arcade import shape_list as shape_list
+from arcade import hitbox as hitbox
+from arcade import experimental as experimental
+from arcade.types import rect
+
+# For ease of access for beginners
+from pyglet.math import Vec2, Vec3, Vec4
+
+from .text import (
+    draw_text,
+    load_font,
+    create_text_sprite,
+    Text,
+)
+
+__all__ = [
+    "AStarBarrierList",
+    "AnimatedWalkingSprite",
+    "TextureAnimationSprite",
+    "TextureAnimation",
+    "TextureKeyframe",
+    "ArcadeContext",
+    "ControllerManager",
+    "FACE_DOWN",
+    "FACE_LEFT",
+    "FACE_RIGHT",
+    "FACE_UP",
+    "MOUSE_BUTTON_LEFT",
+    "MOUSE_BUTTON_MIDDLE",
+    "MOUSE_BUTTON_RIGHT",
+    "NoOpenGLException",
+    "PerfGraph",
+    "PhysicsEnginePlatformer",
+    "PhysicsEngineSimple",
+    "PyMunk",
+    "PymunkException",
+    "PymunkPhysicsEngine",
+    "PymunkPhysicsObject",
+    "Rect",
+    "LBWH",
+    "LRBT",
+    "XYWH",
+    "Section",
+    "SectionManager",
+    "Scene",
+    "SceneKeyError",
+    "Sound",
+    "BasicSprite",
+    "Sprite",
+    "SpriteType",
+    "PymunkMixin",
+    "SpriteCircle",
+    "SpriteList",
+    "SpriteSolidColor",
+    "Text",
+    "Texture",
+    "TextureCacheManager",
+    "SpriteSheet",
+    "DefaultTextureAtlas",
+    "TileMap",
+    "VERSION",
+    "Vec2",
+    "Vec3",
+    "Vec4",
+    "View",
+    "Window",
+    "astar_calculate_path",
+    "check_for_collision",
+    "check_for_collision_with_list",
+    "check_for_collision_with_lists",
+    "close_window",
+    "disable_timings",
+    "draw_arc_filled",
+    "draw_arc_outline",
+    "draw_circle_filled",
+    "draw_circle_outline",
+    "draw_ellipse_filled",
+    "draw_ellipse_outline",
+    "draw_line",
+    "draw_line_strip",
+    "draw_lines",
+    "draw_lrbt_rectangle_filled",
+    "draw_lrbt_rectangle_filled",
+    "draw_lrbt_rectangle_outline",
+    "draw_lrbt_rectangle_outline",
+    "draw_parabola_filled",
+    "draw_parabola_outline",
+    "draw_point",
+    "draw_points",
+    "draw_polygon_filled",
+    "draw_polygon_outline",
+    "draw_rect_filled",
+    "draw_rect_outline",
+    "draw_text",
+    "draw_texture_rect",
+    "draw_sprite",
+    "draw_sprite_rect",
+    "draw_triangle_filled",
+    "draw_triangle_outline",
+    "draw_lbwh_rectangle_filled",
+    "draw_lbwh_rectangle_outline",
+    "enable_timings",
+    "exit",
+    "finish_render",
+    "get_closest_sprite",
+    "get_display_size",
+    "get_distance_between_sprites",
+    "get_sprites_in_rect",
+    "get_controllers",
+    "get_game_controllers",
+    "get_image",
+    "get_joysticks",
+    "get_pixel",
+    "get_points_for_thick_line",
+    "get_screens",
+    "get_sprites_at_exact_point",
+    "get_sprites_at_point",
+    "SpatialHash",
+    "get_timings",
+    "create_text_sprite",
+    "clear_timings",
+    "get_window",
+    "get_fps",
+    "has_line_of_sight",
+    "load_animated_gif",
+    "load_font",
+    "load_sound",
+    "load_spritesheet",
+    "load_texture",
+    "load_image",
+    "make_circle_texture",
+    "make_soft_circle_texture",
+    "make_soft_square_texture",
+    "open_window",
+    "print_timings",
+    "play_sound",
+    "read_tmx",
+    "load_tilemap",
+    "run",
+    "schedule",
+    "set_background_color",
+    "set_window",
+    "start_render",
+    "stop_sound",
+    "timings_enabled",
+    "unschedule",
+    "schedule_once",
+    "get_default_texture",
+    "get_default_image",
+    "hitbox",
+    "experimental",
+    "rect",
+    "color",
+    "csscolor",
+    "key",
+    "resources",
+    "types",
+    "math",
+    "shape_list",
+    "Camera2D",
+]
+
+__version__ = VERSION
+
+# Piggyback on pyglet's doc run detection
+if not getattr(sys, "is_pyglet_doc_run", False):
+    # Load additional game controller mappings to Pyglet
+    if not headless:
+        try:
+            import pyglet.input.controller
+
+            mappings_file = resources.resolve(":system:gamecontrollerdb.txt")
+            # TODO: remove string conversion once fixed upstream
+            pyglet.input.controller.add_mappings_from_file(str(mappings_file))
+        except AssertionError:
+            pass

arcade-3.0.0.dev31/arcade/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from arcade.management import show_info
+
+if __name__ == "__main__":
+    show_info()

arcade-3.0.0.dev31/arcade/__pyinstaller/hook-arcade.py

@@ -0,0 +1,53 @@
+"""
+"Hook" file for pyinstaller - enables Arcade to be easily packaged with PyInstaller.
+
+Docs: https://pyinstaller.readthedocs.io/en/stable/hooks.html
+Official Sample: https://github.com/pyinstaller/hooksample
+
+Note: See setup.cfg for entry points that enable this hook file to be found
+
+For a walk through of building an Arcade application with pyinstaller see:
+https://api.arcade.academy/en/latest/tutorials/bundling_with_pyinstaller/index.html
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pymunk
+from PyInstaller.compat import is_darwin, is_unix, is_win
+
+import arcade
+
+pymunk_path = Path(pymunk.__file__).parent
+arcade_path = Path(arcade.__file__).parent
+
+datas = [
+    (
+        arcade_path / "resources" / "system",
+        "./arcade/resources/system",
+    ),
+    (
+        arcade_path / "VERSION",
+        "./arcade/VERSION",
+    ),
+]
+
+if is_win:
+    binaries = [
+        (pymunk_path / "_chipmunk.pyd", "."),
+    ]
+elif is_darwin:
+    binaries = [
+        (pymunk_path / "_chipmunk.abi3.so", "."),
+        (arcade_path / "lib", "./arcade/lib"),
+    ]
+elif is_unix:
+    binaries = [
+        (pymunk_path / "_chipmunk.abi3.so", "."),
+    ]
+else:
+    raise NotImplementedError(
+        "You are running on an unsupported operating system. "
+        "Only Linux, Mac, and Windows are supported."
+    )