semvec/pypi-packages huggingface dataset:
kitica 1.4a9
Kitica Devicepool.
License: MIT License

Kitica API
================

## Introduction
Kitica's REST API was built to support parallel device automation testing,
It serves device's information through HTTP protocol.

## Setup
Kitica's API service was designed to be hosted behind **nginx** web server, but could also
be run locally for development.

### Development Server Setup
**Step 1**  
Before anything else, it is recommended that you run the service in a virtual environment.  
So, first, install python'3 virtualenv.
```bash
pip install virtualenv
```
After installing, create a virtualenv inside the api folder(``repository_root/api``). Run:
```bash
virtualenv venv
```
> Where venv is the name of the virtualenv instance.  

Output
```bash
Using base prefix '/usr'
New python executable in /home/yourusername/sample/venv/bin/python3
Also creating executable in /home/yourusername/sample/venv/bin/python
Installing setuptools, pip, wheel...
done.
```

Next, activate the virtualenv:
```bash
source venv/bin/activate
```
Now that virtualenv is active, install the dependencies for the api service.
```bash
pip install -r requirements.txt
```
After that, all dependencies should be installed.

**Step 2**
To start the API service, run:
```bash
python kiticaApi.py
```
> Output
```bash
 * Serving Flask app "kiticaAPI" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: xxx-xxx-xxx
```
Service should be running now.  
To Verify, Create a get request in postman.  
> **url**: http://localhost:5000/devices  
> **method**: GET  
Response should be something like this:
```json
[
    {
        "deviceId": 3,
        "deviceName": "Pixel 2",
        "platformName": "Android",
        "server": "xxx.xxx.xxx.xxx",
        "port": "4723/wd/hub",
        "udid": "emulator-5554",
        "platformVersion": "9",
        "status": "FREE",
        "teamName": "TEAM",
        "version": 1,
        "borrowerIp": null,
        "borrowerHostname": null,
        "lastBorrowed": "2020-02-12 15:29:29",
        "deviceType": "Emulator"
    }
]
```
That's it, local development server is now running.
kiticaclient 1.4a9
Kitica Devicepool Client.
License: MIT License

Kitica Host Client Listener
================

Contents:
 * [Description](#description)
 * [Installation](#installation)
 * [Features](#features)
 * [Usage](#usage)


### Description
Kitica Host Client Listener enables a machine to host devices for the Kitica Devicepool Setup. It supports device status updates.

### Installation
If you have [pip](http://pip-installer.org/) installed, just run
```bash
pip install kiticaclient==1.1b1
```
To verify installation, you may run:  
_for ADB Client._  
> ``adb-kitica --help`` 

or  
_for iOS Client._
> ``ios-kitica --help``

You may refer to the sample execution below.
```bash
$ adb-kitica --help
usage: adb-kitica [-h] [-k KITICASERVER] [-w WEBDRIVERPATH] [-a ADBHOST]
                  [-p ADBPORT]

optional arguments:
  -h, --help            show this help message and exit
  -k KITICASERVER, --kiticaserver KITICASERVER
                        Kitica API Server URI
  -w WEBDRIVERPATH, --webdriverpath WEBDRIVERPATH
                        Web Driver PATH
  -a ADBHOST, --adbhost ADBHOST
                        The adb host to connect to. Defaults to localhost.
  -p ADBPORT, --adbport ADBPORT
                        The ADB port of the host. Defaults to 5037

$ ios-kitica
usage: ios-kitica [-h] [-k KITICASERVER] [-w WEBDRIVERPATH]

optional arguments:
  -h, --help            show this help message and exit
  -k KITICASERVER, --kiticaserver KITICASERVER
                        Kitica API Server URI
  -w WEBDRIVERPATH, --webdriverpath WEBDRIVERPATH
                        Web Driver PATH
```

### Features
Kitica ``adb-client`` supports auto start of the **ADB server** should it detect that the client is not running.

Client also auto creates ``KITICA_CLIENT_WEBDRIVERS`` which differs for every Operating System, but, follows the same format. It targets the home folder for the users.  
For __linux__ It would be ``/home/<username>/kitica/client/webdrivers``  
For __Windows__ ``C:\Users\<username>\kitica\client\webdrivers``  
For __macOS__ ``/Users/<username>/kitica/client/webdrivers``  


### Usage
**ADB Client**  
To start an Android Debug Bridge kitica client, simply run ``adb-kitica`` on your terminal.
```bash
$ adb-kitica -k http://kitica.server

Base Client Instance Started..
HOST IP :xxx.xxx.xxx.xxx
KITICA SERVER :http://kitica.server
Webdriver PATH :/home/<username>/kitica/client/webdrivers
Starting Android Host Client Listener Service....
adbhost:localhost
adbport:5037
```

**iOS Client**  
TO DO!
rf-kiticalibrary 1.4a9
Test Library for Devicepool Support.
License: MIT License

KiticaLibrary
================

Library Scope: __GLOBAL__  
Created: __02/04/2020 14:55 UTC-8__  


Author: __Joshua Kim Rivera | email:joshua.rivera@mnltechnology.com__

Company: [__Spiralworks Technologies Inc.__](http://www.spiralwrks.com/)


### Contents:
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Generating Documentation](#generating-documentation)


### Introduction
**KiticaLibrary** is a [Robotframework](https://www.robotframework.org) Test Library for Devicepool support.  

It is a Robot Framework third party library that enables test to borrow available user from a device pool. These allows test to run in CI server without user conflict and lessen setup and maintenance on a project.  
![PyPI](https://img.shields.io/pypi/v/rf-kiticalibrary?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dm/rf-kiticalibrary?style=for-the-badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rf-kiticalibrary?style=for-the-badge)

View the latest keyword [Documentation here.](https://mainsystemdev.github.io/kitica/)  

### Installation
Install using pypi, run:
```bash
pip install rf-kiticalibrary
```

### Usage
To use UserpoolLibrary in Robot Framework tests, the library needs to
first be imported using the `Library` setting as any other library.  

```robotframework
*** Settings ***
Documentation                               Demo file for KiticaLibrary

Library                                     KiticaLibrary
...                                         http://kitica.api

*** Test Case ***
Test Borrow
    [Documentation]                         Sample Borrow Device.
    ${device}                               Borrow Android Device
    Set Global Variable                     ${device}

Test Return
    [Documentation]                         Test Return Device
    Log To Console                          ${device}
    Return Device                           ${device}
```

### Generating Documentation
To Generate the keyword Documentation, simple run:
```bash
python -m robot.libdoc KiticaLibrary documentation.html
```
> Where documentation.html is the name of the documentation file to be generated.  
Note that the library must first be installed before generating a documentation.