| Name | lablink-client-service JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Lablink Client Service that will be installed in the lablink-client-base-image |
| upload_time | 2025-07-28 20:54:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
vm
docker
postgres
tutorial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# lablink-client-service
## Description
This folder contains the Python Package installed in the VM instance. The service is designed to run on a Ubuntu system with NVIDIA GPU support, specifically for use with Chrome Remote Desktop. This is the client side (VM instance) of the LabLink infrastructure. The `subscribe.py` will run as a startup script in the VM.
## Installation
Install Lablink Client Service from [PyPI](https://pypi.org/project/lablink-client-service/).
```bash
pip install lablink-client-service
```
If installed properly, you should be able to run the following command:
```bash
subscribe
```
## Usage in the Client VM
Run the following command with necessary configuration based on the allocator's host and port manually in the VM instance terminal:
```bash
subscribe allocator.host=<allocator_host> allocator.port=<allocator.port>
```
This command will subscribe to the message from the allocator web application.
## Configuration
The configuration can be overridden by passing a different config file path as an argument to the script. For example:
```bash
python -m lablink_client_service.subscribe allocator.host=<your_allocator_host> allocator.port=<your_allocator_port>
```
- `allocator.host`: The hostname of the allocator server.
- `allocator.port`: The port of the allocator server.
You can also fix the configuration by modifying the `config.yaml` file in the `lablink_client_service` directory. The script will automatically load the configuration from this file.
## Development Setup
For developers modifying this package, follow this guide. While the VMs will just install these dependencies globally, developers should use a venv. For developers:
1. Open terminal in project root directory
2. Create a virtual environment
```bash
python3 -m venv venv
```
3. Activate the virtual environment
```bash
source venv/bin/activate
```
4. Install the dependencies
```bash
pip install -e ".[dev]"
```
5. Deactivate the virtual environment when done
```bash
deactivate
```
6. To remove the virtual environment, delete the `venv` directory
## Usage in Local Machine
Run the `subscribe.py` script to start the service. This script will subscribe to the LabLink server and listen for incoming messages.
```bash
python -m lablink_client_service.subscribe
```
> This script will run with the default configuration. To change the configuration, you can modify the `config.yaml` file in the `lablink_client_service` directory. The script will automatically load the configuration from this file.
Raw data
{
"_id": null,
"home_page": null,
"name": "lablink-client-service",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "vm, docker, postgres, tutorial",
"author": null,
"author_email": "Amitha Attapu <amithaattapu0509@gmail.com>, Andrew Park <hep003@ucsd.edu>",
"download_url": "https://files.pythonhosted.org/packages/ef/9d/241cb16fe44f611e12d4c125a04c1d6a8225c9562b44ee4b29aada0f6ef2/lablink_client_service-0.0.4.tar.gz",
"platform": null,
"description": "# lablink-client-service\n\n## Description\nThis folder contains the Python Package installed in the VM instance. The service is designed to run on a Ubuntu system with NVIDIA GPU support, specifically for use with Chrome Remote Desktop. This is the client side (VM instance) of the LabLink infrastructure. The `subscribe.py` will run as a startup script in the VM.\n\n## Installation\nInstall Lablink Client Service from [PyPI](https://pypi.org/project/lablink-client-service/). \n\n```bash\npip install lablink-client-service\n```\n\nIf installed properly, you should be able to run the following command:\n\n```bash\nsubscribe\n```\n\n## Usage in the Client VM\nRun the following command with necessary configuration based on the allocator's host and port manually in the VM instance terminal:\n\n```bash\nsubscribe allocator.host=<allocator_host> allocator.port=<allocator.port>\n```\n\nThis command will subscribe to the message from the allocator web application. \n\n## Configuration\nThe configuration can be overridden by passing a different config file path as an argument to the script. For example:\n\n```bash\npython -m lablink_client_service.subscribe allocator.host=<your_allocator_host> allocator.port=<your_allocator_port>\n```\n\n- `allocator.host`: The hostname of the allocator server.\n- `allocator.port`: The port of the allocator server.\n\nYou can also fix the configuration by modifying the `config.yaml` file in the `lablink_client_service` directory. The script will automatically load the configuration from this file.\n\n## Development Setup\nFor developers modifying this package, follow this guide. While the VMs will just install these dependencies globally, developers should use a venv. For developers:\n\n1. Open terminal in project root directory\n2. Create a virtual environment\n\n```bash\npython3 -m venv venv\n```\n\n3. Activate the virtual environment\n\n```bash\nsource venv/bin/activate\n```\n\n4. Install the dependencies\n\n```bash\npip install -e \".[dev]\"\n```\n\n5. Deactivate the virtual environment when done\n\n```bash\ndeactivate\n```\n\n6. To remove the virtual environment, delete the `venv` directory\n\n## Usage in Local Machine\n\nRun the `subscribe.py` script to start the service. This script will subscribe to the LabLink server and listen for incoming messages.\n\n```bash\npython -m lablink_client_service.subscribe\n```\n\n> This script will run with the default configuration. To change the configuration, you can modify the `config.yaml` file in the `lablink_client_service` directory. The script will automatically load the configuration from this file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Lablink Client Service that will be installed in the lablink-client-base-image",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/talmolab/lablink",
"Issues": "https://github.com/talmolab/lablink/issues"
},
"split_keywords": [
"vm",
" docker",
" postgres",
" tutorial"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "21f724c1bf9dd28710e2bc6871c125a4c30438fb3c3b3f895c94e18e389f7153",
"md5": "9035ef3933a7c848bbba36f6512e0f61",
"sha256": "88c3310d6299bddc996e031f2bd158b7265cde3b835435f0235080f4c1878fc5"
},
"downloads": -1,
"filename": "lablink_client_service-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9035ef3933a7c848bbba36f6512e0f61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11258,
"upload_time": "2025-07-28T20:54:28",
"upload_time_iso_8601": "2025-07-28T20:54:28.344743Z",
"url": "https://files.pythonhosted.org/packages/21/f7/24c1bf9dd28710e2bc6871c125a4c30438fb3c3b3f895c94e18e389f7153/lablink_client_service-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ef9d241cb16fe44f611e12d4c125a04c1d6a8225c9562b44ee4b29aada0f6ef2",
"md5": "3452df7f2615e0201d9bea919384b223",
"sha256": "b6edee7b810914f26fb078946b144d2e0c7118620acd1ea91723a44df2a0d0e5"
},
"downloads": -1,
"filename": "lablink_client_service-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "3452df7f2615e0201d9bea919384b223",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10777,
"upload_time": "2025-07-28T20:54:29",
"upload_time_iso_8601": "2025-07-28T20:54:29.656379Z",
"url": "https://files.pythonhosted.org/packages/ef/9d/241cb16fe44f611e12d4c125a04c1d6a8225c9562b44ee4b29aada0f6ef2/lablink_client_service-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 20:54:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "talmolab",
"github_project": "lablink",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lablink-client-service"
}
