# rfhub2
[](https://travis-ci.com/pbylicki/rfhub2)
[](https://codecov.io/gh/pbylicki/rfhub2)
[](https://pypi.org/project/rfhub2/)
[](https://pypi.org/project/rfhub2/)
[](https://pypi.org/project/rfhub2/)
## 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
```
#### With helm chart
create app on kubernetes cluster
```
helm upgrade --install rfhub2 helm/rfhub2 -n [NAMESPACE]
```
will create all needed resources with configuration from [values.yaml](helm/rfhub2/values.yaml)
## 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
```
To populate app only including or excluding keywords with tags matching custom patterns (more information on the include/exclude feature [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#tag-patterns)):
```bash
# Including keywords containing tag "your-tag" and not containing tag "your-other-tag":
rfhub2-cli --include your-tag --exclude your-other-tag ../your_repo ../your_other_repo
# To populate app only with keywords containing either tag "💡" or "🔧", and tag "🤖":
rfhub2-cli --include 💡OR🔧AND🤖 ../your_repo ../your_other_repo
# To populate app only with keywords containing tags starting by "important-tag-":
rfhub2-cli --include important-tag-* ../your_repo ../your_other_repo
```
##### Rfhub2-cli for keywords documentation can be run in three load-modes:
- `merge`, default mode, updates only matched collections, does nothing with not matched ones
``` rfhub2-cli --load-mode=merge ../your_repo ../your_other_repo```
- `insert`, 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 from 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/pbylicki/rfhub2/",
"name": "rfhub2",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "robotframework",
"author": "Pawel Bylicki, Maciej Wiczk",
"author_email": "pawelkbylicki@gmail.com, maciejwiczk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6c/37/73bad0bc933a5d3235fdc11e75dbb137d51aaea69f4d265a1e2b86ce1816/rfhub2-0.31.tar.gz",
"platform": null,
"description": "# rfhub2\n\n[](https://travis-ci.com/pbylicki/rfhub2)\n[](https://codecov.io/gh/pbylicki/rfhub2)\n[](https://pypi.org/project/rfhub2/)\n[](https://pypi.org/project/rfhub2/)\n[](https://pypi.org/project/rfhub2/)\n\n\n\n## Introduction\nRfHub2 is an opensource project aimed to provide nice and easy way of collecting, browsing and sharing documentation \nof existing keywords written in RobotFramework and python. Built with [Material-UI](https://material-ui.com/) \nand [FastAPI](https://fastapi.tiangolo.com/), served by [Uvicorn](https://www.uvicorn.org/).\\\nProject is inspired by [robotframework-hub](https://github.com/boakley/robotframework-hub) \ncreated by Bryan Oakley and can be treated as its spiritual successor.\n\nRfHub2 is hosted on [GitHub](https://github.com/pbylicki/rfhub2), where sourcecode, current issues and additional documentation can be found.\n\n## Installation\n#### As python package\nlatest version can be installed from PyPi:\n```\npip install rfhub2\n```\nor directly from source code:\n```\npython setup.py install\n```\n#### With docker\npull docker image with SQLite:\n```\ndocker pull pbylicki/rfhub2\n```\nor PostgreSQL:\n```\ndocker pull pbylicki/rfhub2:postgres\n```\n#### With helm chart\ncreate app on kubernetes cluster\n```\nhelm upgrade --install rfhub2 helm/rfhub2 -n [NAMESPACE] \n```\nwill create all needed resources with configuration from [values.yaml](helm/rfhub2/values.yaml)\n\n## Starting application\n#### Run application (web server)\nTo run with default (SQLite) database:\n```\nrfhub2\n```\nTo run with PostgreSQL database:\n```\nRFHUB_DB_URI=postgresql://postgres:postgres@localhost:5432/postgres rfhub2\n```\nTo run application using docker image with default (SQLite) database:\n```\ndocker run -it -p 8000:8000 pbylicki/rfhub2\n```\nTo run application using docker image with Postgres database:\n```\ndocker run -it -p 8000:8000 --network=host -e RFHUB_DB_URI=\"postgresql://postgres:postgres@localhost:5432/postgres\" pbylicki/rfhub2:postgres\n```\n#### Populate application with keywords documentation\nTo populate application running on localhost:\n```\nrfhub2-cli ../your_repo ../your_other_repo\n```\nTo populate app running on another host, with non-default credentials:\n```\nrfhub2-cli -a http://your_host:8000 -u user -p password ../your_repo ../your_other_repo\n```\nTo populate app but to skip loading RFWK installed libraries:\n```\nrfhub2-cli --no-installed-keywords ../your_repo ../your_other_repo\n```\nTo populate app only including or excluding keywords with tags matching custom patterns (more information on the include/exclude feature [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#tag-patterns)):\n```bash\n# Including keywords containing tag \"your-tag\" and not containing tag \"your-other-tag\":\nrfhub2-cli --include your-tag --exclude your-other-tag ../your_repo ../your_other_repo\n\n# To populate app only with keywords containing either tag \"\ud83d\udca1\" or \"\ud83d\udd27\", and tag \"\ud83e\udd16\":\nrfhub2-cli --include \ud83d\udca1OR\ud83d\udd27AND\ud83e\udd16 ../your_repo ../your_other_repo\n\n# To populate app only with keywords containing tags starting by \"important-tag-\":\nrfhub2-cli --include important-tag-* ../your_repo ../your_other_repo\n```\n\n##### Rfhub2-cli for keywords documentation can be run in three load-modes:\n- `merge`, default mode, updates only matched collections, does nothing with not matched ones\n``` rfhub2-cli --load-mode=merge ../your_repo ../your_other_repo```\n- `insert`, that will clean up existing collections app and load all collections found in provided paths\n``` rfhub2-cli --load-mode=insert ../your_repo ../your_other_repo```\n- `append`, which will only add collections from provided paths\n``` rfhub2-cli --load-mode=append ../your_repo ../your_other_repo```\n- `update`, which will compare existing collections with newly found ones, and update existing, remove obsolete and add new ones\n``` rfhub2-cli --load-mode=update ../your_repo ../your_other_repo```\n\n#### Populate application with keywords execution statistics\n##### To gather keywords execution statistics:\n``` \nrfhub2-cli --mode=statistics ../your_execution_dir ../your_other_execution_dir\n```\nSince execution statistics from specific run does not change over time, there is no load-mode needed.\nApplication will scan all of the executions and try to send aggregated data from each run to application.\nrfhub2-cli will complain that there are existing statistics for particular timestamp, and will proceed with next ones. \n## License\nRfHub2 is an open source software provided under the [Apache License 2.0](http://apache.org/licenses/LICENSE-2.0)\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Webserver for robot framework and python assets documentation",
"version": "0.31",
"project_urls": {
"Homepage": "https://github.com/pbylicki/rfhub2/"
},
"split_keywords": [
"robotframework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19628e562a6cbeaa1eb2cee9bab08350c96c5b79c029d074bb253b6f7a2a9e48",
"md5": "1191fe9cb17a9efea3be060a181b940b",
"sha256": "43e93e03435369d39b6b6a45be6151c236b03f8158a61d4cf8e93d7b60f96b6c"
},
"downloads": -1,
"filename": "rfhub2-0.31-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1191fe9cb17a9efea3be060a181b940b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 646584,
"upload_time": "2023-07-24T22:36:26",
"upload_time_iso_8601": "2023-07-24T22:36:26.181664Z",
"url": "https://files.pythonhosted.org/packages/19/62/8e562a6cbeaa1eb2cee9bab08350c96c5b79c029d074bb253b6f7a2a9e48/rfhub2-0.31-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6c3773bad0bc933a5d3235fdc11e75dbb137d51aaea69f4d265a1e2b86ce1816",
"md5": "0789a3f2e1f9108cd34b85995fa4df8a",
"sha256": "37358d6a4a1b635a275c4a576ff048f118496d82059d3cd2169be28a1491d617"
},
"downloads": -1,
"filename": "rfhub2-0.31.tar.gz",
"has_sig": false,
"md5_digest": "0789a3f2e1f9108cd34b85995fa4df8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 619954,
"upload_time": "2023-07-24T22:36:27",
"upload_time_iso_8601": "2023-07-24T22:36:27.999794Z",
"url": "https://files.pythonhosted.org/packages/6c/37/73bad0bc933a5d3235fdc11e75dbb137d51aaea69f4d265a1e2b86ce1816/rfhub2-0.31.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-24 22:36:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pbylicki",
"github_project": "rfhub2",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "rfhub2"
}
JSON
