Skip to main content

Connor's Remote Events (RE) is a simple library that allows the end-user to call python functions from another server.

Project description

Connor's Remote Events (RE)

Connor's Remote Events (RE) is a simple library that allows the end-user to call python functions from another server. This is highly powerful if you are coding an application that offloads processes to another server.

If you want to offload automation tasks to another device, this is the package to use. It is extremely reliable and robust for near-effort python automation

Example main.py

In two terminals:

  1. First terminal, run the server with python main.py server

  2. Second terminal, run the client with python main.py client

"""
Main Example Script for RemoteFunctions

This script demonstrates remote function execution over HTTP using the RemoteFunctions class.
It operates in two modes:
    1. Server mode: Registers functions and starts a Flask server to handle remote calls.
    2. Client mode: Connects to the server, retrieves available functions, and invokes them remotely.

All communications are serialized with pickle for reliable data exchange.

Usage:
    To run as a server:
        python main.py server
    To run as a client:
        python main.py client

Note: Ensure the server is running before starting the client.
"""

from remote_functions import RemoteFunctions
import sys
from typing import Any

# Initialize RemoteFunctions with password authentication.
rf = RemoteFunctions(password="Whoop!-")

@rf.as_remote()
def a(b: Any) -> Any:
    """Return the input value."""
    return b

@rf.as_remote()
def add(x: float | int, y: float | int) -> float | int:
    """Return the sum of x and y."""
    return x + y

if __name__ == "__main__":
    if len(sys.argv) > 1 and sys.argv[1] == "server":
        # Start the server (blocking call) on 0.0.0.0:5000.
        rf.start_server(host="0.0.0.0", port=5000)

    elif len(sys.argv) > 1 and sys.argv[1] == "client":
        # Connect to the server running on localhost:5000.
        rf.connect_to_server("localhost", 5000)

        print("Invoking function 'a' with argument 'Hello World!'")
        result = a("Hello World!")
        print("Result:", result)

        print("Invoking function 'add' with arguments 1 and 3")
        result = add(1, 3)
        print("Result:", result)
    else:
        print("Usage: python main.py [server|client]")

Project details


Release history Release notifications | RSS feed

This version

0.2.5

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

remote_events-0.2.5.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

remote_events-0.2.5-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file remote_events-0.2.5.tar.gz.

File metadata

  • Download URL: remote_events-0.2.5.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for remote_events-0.2.5.tar.gz
Algorithm Hash digest
SHA256 1435d00b956ea974117592d50ac4db79c643b5d3421649402a03d9fbf4b9b154
MD5 c491964268ba1148947a2d5b1710a832
BLAKE2b-256 3ddd331edb11257bb9a4aaa4b8e58eabbeacbdcb38df98037da3f76efcf23627

See more details on using hashes here.

File details

Details for the file remote_events-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: remote_events-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for remote_events-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 40e7f526c67101dfcf8cbb37b5843a28dc932592820e84ae06b0666ff5a8eaec
MD5 7df534de826381ece974f57edc262d0e
BLAKE2b-256 f646876a43d53af26b1d91025767afcd8d755e9c1e8c81a4d17f71eba825d0ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page