ach-raf / open_link_server

MIT License
1 stars 0 forks source link

OpenLink Server a CLI Python Program

Introduction

This Python program acts as a backend for OpenLink Client an Android app, serving as a remote controller using a local network connection. It listens for commands and links sent over the network and executes corresponding actions on the host machine.

Features

Screenshots

Here are some screenshots showcasing the program in action:

Android Companion App CLI Server receiving commands

Prerequisites

Installation

  1. Clone the repository to your local machine:

    git clone git@github.com:ach-raf/open_link_server.git
  2. Navigate to the project directory:

    cd your-repository
  3. Create a virtual environment:

    python -m venv venv
  4. Activate the virtual environment (on Windows):

    venv\Scripts\activate
  5. Install the required Python packages:

    pip install -r requirements.txt

Usage

  1. Run the program:

    python server_cli.py
  2. Ensure that the host machine and the Android device are connected to the same local network.

  3. Use the Android app to send commands or links to the host machine's IP address.

Commands

Additional Notes

If you prefer running the script in a Windows environment using a batch file, you can create a batch file (e.g., run_server.bat) with the following content:

@echo off
cls
C:\path\to\your\venv\Scripts\python.exe C:\path\to\your\server_cli.py
pause

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to enhance the functionality of the program.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments