Metadata-Version: 2.1
Name: rfhub2
Version: 0.16
Summary: Webserver for robot framework and python assets documentation
Home-page: https://github.com/pbylicki/rfhub2/
Author: Pawel Bylicki, Maciej Wiczk
Author-email: pawelkbylicki@gmail.com, maciejwiczk@gmail.com
License: Apache License 2.0
Description: # rfhub2
        
        [![Build Status](https://travis-ci.org/pbylicki/rfhub2.svg?branch=master)](https://travis-ci.org/pbylicki/rfhub2)
        [![codecov](https://codecov.io/gh/pbylicki/rfhub2/branch/master/graph/badge.svg)](https://codecov.io/gh/pbylicki/rfhub2)
        [![image](https://img.shields.io/pypi/v/rfhub2.svg)](https://pypi.org/project/rfhub2/)
        [![image](https://img.shields.io/pypi/pyversions/rfhub2.svg)](https://pypi.org/project/rfhub2/)
        [![image](https://img.shields.io/pypi/wheel/rfhub2.svg)](https://pypi.org/project/rfhub2/)
        ![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/pbylicki/rfhub2.svg)
        ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/pbylicki/rfhub2.svg)
        
        ## Introduction
        RfHub2 is an opensource project aimed to provide nice and easy way of collecting, browsing and sharing documentation 
        of existing keywords written in RobotFramework and python. Built with [Material-UI](https://material-ui.com/) 
        and [FastAPI](https://fastapi.tiangolo.com/), served by [Uvicorn](https://www.uvicorn.org/).\
        Project is inspired by [robotframework-hub](https://github.com/boakley/robotframework-hub) 
        created by Bryan Oakley and can be treated as its spiritual successor.
        
        RfHub2 is hosted on [GitHub](https://github.com/pbylicki/rfhub2), where sourcecode, current issues and additional documentation can be found.
        
        ## Installation
        #### As python package
        latest version can be installed from PyPi:
        ```
        pip install rfhub2
        ```
        or directly from source code:
        ```
        python setup.py install
        ```
        #### With docker
        pull docker image with SQLite:
        ```
        docker pull pbylicki/rfhub2
        ```
        or PostgreSQL:
        ```
        docker pull pbylicki/rfhub2:postgres
        ```
        ## Starting application
        #### Run application (web server)
        To run with default (SQLite) database:
        ```
        rfhub2
        ```
        To run with PostgreSQL database:
        ```
        RFHUB_DB_URI=postgresql://postgres:postgres@localhost:5432/postgres rfhub2
        ```
        To run application using docker image with default (SQLite) database:
        ```
        docker run -it -p 8000:8000 pbylicki/rfhub2
        ```
        To run application using docker image with Postgres database:
        ```
        docker run -it -p 8000:8000 --network=host -e RFHUB_DB_URI="postgresql://postgres:postgres@localhost:5432/postgres" pbylicki/rfhub2:postgres
        ```
        #### Populate application with keywords documentation
        To populate application running on localhost:
        ```
        rfhub2-cli ../your_repo ../your_other_repo
        ```
        To populate app running on another host, with non-default credentials:
        ```
        rfhub2-cli -a http://your_host:8000 -u user -p password ../your_repo ../your_other_repo
        ```
        To populate app but to skip loading RFWK installed libraries:
        ```
        rfhub2-cli --no-installed-keywords ../your_repo ../your_other_repo
        ```
        ##### Rfhub2-cli for keywords documentation can be run in three load-modes:
        
        - `insert`, default mode, that will clean up existing collections app and load all collections found in provided paths  
        ``` rfhub2-cli --load-mode=insert ../your_repo ../your_other_repo```
        - `append`, which will only add collections form provided paths  
        ``` rfhub2-cli --load-mode=append ../your_repo ../your_other_repo```
        - `update`, which will compare existing collections with newly found ones, and update existing, remove obsolete and add new ones  
        ``` rfhub2-cli --load-mode=update ../your_repo ../your_other_repo```
        
        #### Populate application with keywords execution statistics
        ##### To gather keywords execution statistics:
        ``` 
        rfhub2-cli --mode=statistics ../your_execution_dir ../your_other_execution_dir
        ```
        Since execution statistics from specific run does not change over time, there is no load-mode needed.
        Application will scan all of the executions and try to send aggregated data from each run to application.
        rfhub2-cli will complain that there are existing statistics for particular timestamp, and will proceed with next ones.  
        ## License
        RfHub2 is an open source software provided under the [Apache License 2.0](http://apache.org/licenses/LICENSE-2.0)
        
Keywords: robotframework
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Unix
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Tool
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
Provides-Extra: postgresql
