<h1 align="center"> miqsel</h1>
<h3 align="center">Miq Selenium Server</h3>
<p align="center">
<a href="https://pypi.org/project/miqsel"><img alt="Python Versions"
src="https://img.shields.io/pypi/pyversions/miqsel.svg?style=flat"></a>
<a href="https://github.com/digitronik/miqsel/actions?query=workflow%3A%22%F0%9F%95%B5%EF%B8%8F+Test+suite%22"><img alt="Build Status"
src="https://github.com/digitronik/miqsel/workflows/%F0%9F%95%B5%EF%B8%8F%20Test%20suite/badge.svg"></a>
<a href="https://github.com/digitronik/miqsel/blob/master/LICENSE"><img alt="License: GPLV3"
src="https://img.shields.io/pypi/l/miqsel.svg?version=latest"></a>
<a href="https://pypi.org/project/miqsel/#history"><img alt="PyPI version"
src="https://badge.fury.io/py/miqsel.svg"></a>
<a href="https://pepy.tech/project/miqsel"><img alt="Downloads"
src="https://pepy.tech/badge/miqsel"></a>
<a href="https://pypi.org/project/black"><img alt="Code style: black"
src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
`miqsel` is a Python CLI utility leaveraging a Selenium container image to efficiently manage a
`selenium server` and provide `vnc` access.
### Prerequisite:
1. **Podman/Docker**:
Make sure `podman` or `docker` running on your system.
- [Podman Installation](https://podman.io/getting-started/installation.html)
- [Docker Installation](https://docs.docker.com/engine/install/)
2. **VNC Viewer**:
You can choose any vnc viewer but most of user used _tigervnc_.
- Fedora:
```
sudo dnf install tigervnc
```
- [TigerVNC link for other Distro's](http://tigervnc.bphinz.com/nightly/)
### Installation:
```bash
pip install miqsel --user
```
or
```bash
pip install git+https://github.com/digitronik/miqsel#egg=miqsel --user
```
## Usage:
- **Help**:
```shell
❯❯❯ miqsel --help
Usage: miqsel [OPTIONS] COMMAND [ARGS]...
Miq Selenium Server
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
config Set Configuration
executor Selenium executor URL
start Start Selenium Server
status Status of Selenium Server
stop Stop Selenium Server
viewer VNC viewer
vnc VNC URL
```
- **Status**:
Check status of selenium container (running/ stopped).
```shell
❯❯❯ miqsel status
stopped
```
- **Start/Stop**:
```shell
❯❯❯ miqsel start
Selenium Server started
TigerVNC Viewer 64-bit v1.9.0
❯❯❯ miqsel stop
Sun Apr 28 12:29:02 2019
CConn: End of stream
Selenium Server stopped
```
Note: `start` default invoke `vnc-viewer`. You can stop it like `miqsel start --no-viewer`
- **Viewer**:
Take `vnc` access of selenium server. At the start of selenium server, vnc viewer will be `invoked` automatically.
If the `status` is `running` and the `viewer` is `close` then viewer command will help to re-open vnc session.
```shell
❯❯❯ miqsel status
running
❯❯❯ miqsel viewer
TigerVNC Viewer 64-bit v1.9.0
```
- **Executor**:
Get command executor url
```shell
❯❯❯ miqsel executor
http://172.17.0.2:4444/wd/hub
```
- **VNC**:
Get vnc session url
```shell
❯❯❯ miqsel vnc
172.17.0.2:5999
```
- **Configuration**:
Manage your miqsel configuration and change default setting as per need.
```shell
❯❯❯ miqsel config
Container Engine (auto, podman, docker) [auto]:
Selenium container image [selenium/standalone-chrome:latest]:
VNC viewer (auto, vncviewer, vinagre, xdg-open) [auto]:
Selenium server running on port? [4444]:
VNC running on port? [5999]:
Selenium container name [miqsel_container]:
Selenium container network [default]:
Selenium container shared Memory [2g]:
Testing data mount to directory '/data' [default]:
Configuration saved successfully...
```
`selenium/standalone-chrome:latest` is default image. You can use other from [SeleniumHQ](https://github.com/SeleniumHQ/docker-selenium) or custom images.
Raw data
{
"_id": null,
"home_page": "",
"name": "miqsel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "miqsel,selenium",
"author": "",
"author_email": "Nikhil Dhandre <nik.digitronik@live.com>",
"download_url": "https://files.pythonhosted.org/packages/4d/f8/ea30f954dab48b1c00a9e711c71a214b52e4469ec3dfad6faef9a656ecd7/miqsel-3.3.tar.gz",
"platform": null,
"description": "<h1 align=\"center\"> miqsel</h1>\n<h3 align=\"center\">Miq Selenium Server</h3>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/miqsel\"><img alt=\"Python Versions\"\nsrc=\"https://img.shields.io/pypi/pyversions/miqsel.svg?style=flat\"></a>\n<a href=\"https://github.com/digitronik/miqsel/actions?query=workflow%3A%22%F0%9F%95%B5%EF%B8%8F+Test+suite%22\"><img alt=\"Build Status\"\nsrc=\"https://github.com/digitronik/miqsel/workflows/%F0%9F%95%B5%EF%B8%8F%20Test%20suite/badge.svg\"></a>\n<a href=\"https://github.com/digitronik/miqsel/blob/master/LICENSE\"><img alt=\"License: GPLV3\"\nsrc=\"https://img.shields.io/pypi/l/miqsel.svg?version=latest\"></a>\n<a href=\"https://pypi.org/project/miqsel/#history\"><img alt=\"PyPI version\"\nsrc=\"https://badge.fury.io/py/miqsel.svg\"></a>\n<a href=\"https://pepy.tech/project/miqsel\"><img alt=\"Downloads\"\nsrc=\"https://pepy.tech/badge/miqsel\"></a>\n<a href=\"https://pypi.org/project/black\"><img alt=\"Code style: black\"\nsrc=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n</p>\n\n`miqsel` is a Python CLI utility leaveraging a Selenium container image to efficiently manage a\n`selenium server` and provide `vnc` access.\n\n\n### Prerequisite:\n1. **Podman/Docker**:\n\n Make sure `podman` or `docker` running on your system.\n - [Podman Installation](https://podman.io/getting-started/installation.html)\n - [Docker Installation](https://docs.docker.com/engine/install/)\n\n2. **VNC Viewer**:\n\n You can choose any vnc viewer but most of user used _tigervnc_.\n - Fedora:\n ```\n sudo dnf install tigervnc\n ```\n - [TigerVNC link for other Distro's](http://tigervnc.bphinz.com/nightly/)\n\n### Installation:\n```bash\npip install miqsel --user\n```\nor\n```bash\n pip install git+https://github.com/digitronik/miqsel#egg=miqsel --user\n```\n\n## Usage:\n- **Help**:\n ```shell\n \u276f\u276f\u276f miqsel --help\n Usage: miqsel [OPTIONS] COMMAND [ARGS]...\n\n Miq Selenium Server\n\n Options:\n --version Show the version and exit.\n --help Show this message and exit.\n\n Commands:\n config Set Configuration\n executor Selenium executor URL\n start Start Selenium Server\n status Status of Selenium Server\n stop Stop Selenium Server\n viewer VNC viewer\n vnc VNC URL\n ```\n\n- **Status**:\nCheck status of selenium container (running/ stopped).\n ```shell\n \u276f\u276f\u276f miqsel status\n stopped\n ```\n\n- **Start/Stop**:\n ```shell\n \u276f\u276f\u276f miqsel start\n Selenium Server started\n\n TigerVNC Viewer 64-bit v1.9.0\n\n \u276f\u276f\u276f miqsel stop\n\n Sun Apr 28 12:29:02 2019\n CConn: End of stream\n Selenium Server stopped\n ```\n Note: `start` default invoke `vnc-viewer`. You can stop it like `miqsel start --no-viewer`\n\n- **Viewer**:\nTake `vnc` access of selenium server. At the start of selenium server, vnc viewer will be `invoked` automatically.\nIf the `status` is `running` and the `viewer` is `close` then viewer command will help to re-open vnc session.\n\n ```shell\n \u276f\u276f\u276f miqsel status\n running\n \u276f\u276f\u276f miqsel viewer\n TigerVNC Viewer 64-bit v1.9.0\n ```\n\n- **Executor**:\nGet command executor url\n ```shell\n \u276f\u276f\u276f miqsel executor\n http://172.17.0.2:4444/wd/hub\n ```\n\n- **VNC**:\nGet vnc session url\n ```shell\n \u276f\u276f\u276f miqsel vnc\n 172.17.0.2:5999\n ```\n\n- **Configuration**:\n Manage your miqsel configuration and change default setting as per need.\n ```shell\n \u276f\u276f\u276f miqsel config\n Container Engine (auto, podman, docker) [auto]:\n Selenium container image [selenium/standalone-chrome:latest]:\n VNC viewer (auto, vncviewer, vinagre, xdg-open) [auto]:\n Selenium server running on port? [4444]:\n VNC running on port? [5999]:\n Selenium container name [miqsel_container]:\n Selenium container network [default]:\n Selenium container shared Memory [2g]:\n Testing data mount to directory '/data' [default]:\n Configuration saved successfully...\n ```\n\n `selenium/standalone-chrome:latest` is default image. You can use other from [SeleniumHQ](https://github.com/SeleniumHQ/docker-selenium) or custom images.\n",
"bugtrack_url": null,
"license": "miqsel Copyright (C) 2018 Nikhil Dhandre This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License. You may obtain a copy of the License at https://www.gnu.org/licenses/gpl-3.0.txt ",
"summary": "miqsel is a Python CLI utility leaveraging a Selenium container image to efficiently manage a Selenium server for streamlined testing wrokflows.",
"version": "3.3",
"project_urls": {
"repository": "https://github.com/digitronik/miqsel"
},
"split_keywords": [
"miqsel",
"selenium"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5197aa885000944b4a86c52dc71b0adcc5c5dfbf2e90eaf9ccaa90e57e1e44d4",
"md5": "3551378beb972bd7460cd589e318f21c",
"sha256": "a8776e9da1f0b46c2cd9bfddf6c0c212a09fce576365a30051939c5980709a4b"
},
"downloads": -1,
"filename": "miqsel-3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3551378beb972bd7460cd589e318f21c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6876,
"upload_time": "2023-11-20T11:32:36",
"upload_time_iso_8601": "2023-11-20T11:32:36.510866Z",
"url": "https://files.pythonhosted.org/packages/51/97/aa885000944b4a86c52dc71b0adcc5c5dfbf2e90eaf9ccaa90e57e1e44d4/miqsel-3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4df8ea30f954dab48b1c00a9e711c71a214b52e4469ec3dfad6faef9a656ecd7",
"md5": "0cceb0e7ef2befe9fd58ab650a2f2b86",
"sha256": "5227e3c31d748611e96eb19fa1739a97634e8766d44312be20b793306f466d63"
},
"downloads": -1,
"filename": "miqsel-3.3.tar.gz",
"has_sig": false,
"md5_digest": "0cceb0e7ef2befe9fd58ab650a2f2b86",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8675,
"upload_time": "2023-11-20T11:32:37",
"upload_time_iso_8601": "2023-11-20T11:32:37.904576Z",
"url": "https://files.pythonhosted.org/packages/4d/f8/ea30f954dab48b1c00a9e711c71a214b52e4469ec3dfad6faef9a656ecd7/miqsel-3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 11:32:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "digitronik",
"github_project": "miqsel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "miqsel"
}
JSON
