pyreverb 1.6.7__tar.gz

pyreverb-1.6.7/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Adrien Dumontet (Labo)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyreverb-1.6.7/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.4
+Name: pyreverb
+Version: 1.6.7
+Summary: Multiplayer library
+Author: Labo
+License: Apache License Version 2.0
+Project-URL: Homepage, https://github.com/LeLaboDuGame/PyReverb
+Project-URL: Source, https://github.com/LeLaboDuGame/PyReverb
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama
+Requires-Dist: pygame
+Dynamic: license-file
+
+
+<p align="center">
+  <img src="src/pyreverb/assets/banner.png" alt="PyReverb Banner">
+</p>
+
+# PyReverb
+
+[![PyPI version](https://img.shields.io/pypi/v/pyreverb.svg)](https://pypi.org/project/pyreverb/)
+![License](https://img.shields.io/github/license/LeLaboDuGame/PyReverb)
+
+PyReverb is a lightweight Python networking framework for real-time client–server synchronization of game and simulation objects.
+
+It is designed to make it easy to:
+
+- Define network-aware objects once, and use them on both server and client
+- Keep object state synchronized across all peers
+- Trigger remote actions using events and RPC-like calls
+- Build fast multiplayer prototypes and real-time simulations
+
+---
+
+## Table of Contents
+
+1. [Features](#features)  
+2. [Why PyReverb](#why-pyreverb)  
+3. [Installation](#installation)  
+4. [Quick Start](#quick-start)  
+   - [1. Define a networked object](#1-define-a-networked-object)  
+   - [2. Minimal server](#2-minimal-server)  
+   - [3. Minimal client](#3-minimal-client)  
+5. [Event System](#event-system)  
+6. [Project Structure](#project-structure)  
+7. [Support](#support)  
+8. [Contributing](#contributing)  
+9. [License](#license)  
+10. [Author](#author)
+
+---
+
+## Features
+
+- **Object synchronization**  
+  Define `ReverbObject` subclasses and keep their state in sync across the network.
+
+- **Client–server framework**  
+  Built-in `Server` and `Client` abstractions to manage connections and messaging.
+
+- **Event-driven architecture**  
+  Register callbacks on custom events (connect, disconnect, gameplay events, etc.).
+
+- **Remote calls / actions**  
+  Execute actions remotely between server and clients in a structured way.
+
+- **Lightweight and focused**  
+  Minimal external dependencies; integrates well with existing game loops (e.g. `pygame`).
+
+---
+
+## Why PyReverb
+
+- **Game-oriented**: Designed with real-time games and interactive simulations in mind.  
+- **Simple mental model**: Think in terms of objects and events, not raw sockets.  
+- **Python-first**: Pure Python API that fits naturally into existing Python projects.  
+- **Extensible**: You control how objects are created, synchronized, and updated.
+
+Use it for:
+
+- 2D/3D multiplayer games  
+- Real-time collaborative tools  
+- Networked simulations and visualizations  
+
+---
+
+## Installation
+
+Requirements:
+
+- Python **3.13+**
+- `virtualenv` or another virtual environment tool (recommended)
+
+Inside your virtual environment:
+```bash
+git clone https://github.com/LeLaboDuGame/PyReverb.git
+cd PyReverb
+
+# Install dependencies for development / local use
+pip install -r requirements.txt
+
+# Or install as a package (editable for development)
+pip install -e .
+```
+You can also install directly from source in another project:
+```
+bash
+pip install git+https://github.com/LeLaboDuGame/PyReverb.git
+```
+---
+
+## Quick Start
+
+Below is a minimal end‑to‑end example showing:
+
+1. How to define a synchronized object
+2. How to start a server
+3. How to connect a client
+
+> The code is written as if you split it into three files: `shared_objects.py`, `server.py`, and `client.py` inside your project.
+
+### 1. Define a networked object
+```python
+# shared_objects.py
+from pyreverb.reverb import ReverbManager, ReverbSide, ReverbObject
+
+# Decide which side you're currently defining for.
+# This file can be imported by both client and server.
+ReverbManager.REVERB_SIDE = ReverbSide.SERVER  # or CLIENT when imported by the client
+
+
+@ReverbManager.reverb_object_attribute
+class Player(ReverbObject):
+    def __init__(self, pos=(0, 0), uid=None, add_on_init=True):
+        # Local attributes that will be synchronized
+        self.pos = list(pos)
+        super().__init__(uid=uid, add_on_init=add_on_init)
+
+    def on_init_from_server(self):
+        # Called when the Player is created on the server
+        print(f"[SERVER] Player {self.uid} initialized at {self.pos}")
+
+    def on_init_from_client(self):
+        # Called when the Player appears on a client
+        print(f"[CLIENT] Player {self.uid} spawned at {self.pos}")
+```
+### 2. Minimal server
+```python
+# server.py
+from pyreverb.reverb import ReverbManager, ReverbSide, Server
+from shared_objects import Player  # noqa: F401 - ensure class is registered
+
+
+def main():
+    # Configure PyReverb as server-side
+    ReverbManager.REVERB_SIDE = ReverbSide.SERVER
+
+    server = Server()
+    ReverbManager.REVERB_CONNECTION = server
+
+    # Start listening for clients
+    server.start_server()
+
+    # Create a player instance on the server
+    player = Player(pos=(5, 5))
+    print(f"[SERVER] Created Player with uid={player.uid}")
+
+    # Main loop placeholder (replace with your game loop)
+    try:
+        while True:
+            # Process network events / messages
+            server.update()
+            # ... your game logic, physics, etc. ...
+    except KeyboardInterrupt:
+        print("[SERVER] Shutting down...")
+        server.stop_server()
+
+
+if __name__ == "__main__":
+    main()
+```
+### 3. Minimal client
+```python
+# client.py
+from pyreverb.reverb import ReverbManager, ReverbSide, Client
+from shared_objects import Player  # noqa: F401 - ensure class is registered
+
+
+def main():
+    # Configure PyReverb as client-side
+    ReverbManager.REVERB_SIDE = ReverbSide.CLIENT
+
+    client = Client()
+    ReverbManager.REVERB_CONNECTION = client
+
+    # Connect to the server (adjust host/port if needed)
+    client.connect(host="127.0.0.1", port=5555)
+
+    # Main loop placeholder (replace with your render / game loop)
+    try:
+        while True:
+            client.update()
+            # Here you would update local input and send changes, e.g.:
+            # for player in Player.get_all_instances():
+            #     player.pos[0] += 1  # move right, for example
+    except KeyboardInterrupt:
+        print("[CLIENT] Disconnecting...")
+        client.disconnect()
+
+
+if __name__ == "__main__":
+    main()
+```
+**How this works:**
+
+- The `Player` class is registered as a networked object via `@ReverbManager.reverb_object_attribute`.
+- The server creates a `Player` instance; PyReverb synchronizes it with connected clients.
+- The client keeps a local mirror of the `Player` instance and can react to updates in its callbacks.
+
+For more advanced usage (multiple object types, more complex logic, etc.), you can follow the same pattern with additional `ReverbObject` subclasses.
+
+---
+
+## Event System
+
+PyReverb uses an event-driven core so that you can react to network events without constantly polling everything manually.
+
+A simplified usage pattern looks like this:
+```python
+from pyreverb.reverb import ReverbManager
+
+kernel = ReverbManager.get_kernel()
+
+@kernel.on_event("client_connected")
+def on_client_connected(client_id):
+    print(f"Client connected: {client_id}")
+
+@kernel.on_event("client_disconnected")
+def on_client_disconnected(client_id):
+    print(f"Client disconnected: {client_id}")
+```
+You can define and emit custom events to coordinate gameplay logic, lobby systems, or other high‑level behaviors above the raw networking layer.
+
+---
+
+## Project Structure
+
+At a high level, the repository is organized as follows:
+
+- `src/pyreverb/` – Core library code  
+- `src/pyreverb/assets/` – Assets such as the README banner  
+- `src/pyreverb/Exemple/` – Example project demonstrating PyReverb in action  
+- `pyproject.toml` – Packaging configuration  
+- `README.md` – Project documentation (this file)  
+
+You can use the example project as a reference when integrating PyReverb into your own game or simulation.
+
+---
+
+## Support
+
+- Open an **Issue** on the repository for bugs or feature requests.  
+- Use **Discussions** (if enabled) for general questions and design ideas.  
+- Check the source and examples for reference implementations.
+
+---
+
+## Contributing
+
+Contributions are welcome.
+
+1. Open an issue to discuss new features or changes.  
+2. Fork the repository and create a feature branch:  
+   ```bash
+   git checkout -b feature/my-feature
+   ```  
+3. Implement your changes and add tests or example usage where appropriate.  
+4. Ensure code style and formatting are consistent.  
+5. Open a Pull Request with a clear description of what you changed and why.
+
+---
+
+## License
+
+This project is licensed under the **Apache License 2.0**.  
+See the [LICENSE](LICENSE) file for the full license text.
+
+---
+
+## Author
+
+PyReverb is maintained by **LeLaboDuGame** (Twitch: https://twitch.tv/LaboTTV). <br>
+For more information and updates, see the project homepage:
+
+- GitHub: https://github.com/LeLaboDuGame/PyReverb
+