Webserver for robot framework assets
Project description
Welcome to Robot Framework Hub
This project implements a simple web server for viewing robot framework keyword documentation. This uses flask to provide both a RESTful interface and a browser-based UI for accessing test assets.
It's crazy easy to get started. To install and run from a PyPi package, do the following:
$ pip install robotframework-hub
$ python -m rfhub
Note: robotframework-hub requires python 3.6 or greater
To run from source it's the same, except that instead of installing, you cd to the folder that has this file.
That's it! You can now browse documentation by visiting the url http://localhost:7070/doc/
Want to browse your local robotframework assets? Just include the path to your test suites or resource files on the command line:
$ python -m rfhub /path/to/test/suite
Websites
Source code, screenshots, and additional documentation can be found here:
- Source code: https://github.com/bli74/robotframework-hub
This is a fork of the initial project:
- Source code (upstream): https://github.com/boakley/robotframework-hub
- Project wiki: https://github.com/boakley/robotframework-hub/wiki
The last changes in this project were added in 2019 and since then pull requests are still open.
This fork includes compatibility fixes and additional functionality:
- Updated requirement versions.
- Completed '.rfhubignore' logic.
- Compatibility fixes for Robot Framework 3.2.x and 4.x
- Support of umbrella libraries. That means libraries that include all libraries from the subdirectrory and provide an aggregated set of keywords. To write tests only this aggregated library should be included and the documentation should list the keywords for this aggregated library only.
Acknowledgements
A huge thank-you to Echo Global Logistics (echo.com) for supporting the development of this package.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file robotframework-hub-bli-1.0.4.tar.gz
.
File metadata
- Download URL: robotframework-hub-bli-1.0.4.tar.gz
- Upload date:
- Size: 193.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa9344630e0f01b7536d45062ffe6643242b762108d0a93ac8fed3006d8e07bc |
|
MD5 | b3d68f9f4043781657eae6d9696ccb41 |
|
BLAKE2b-256 | 428e4270692c4da27ceb1ecdf52ce7928f01ca34cacc4a26fa706e20885b7d84 |
File details
Details for the file robotframework_hub_bli-1.0.4-py3-none-any.whl
.
File metadata
- Download URL: robotframework_hub_bli-1.0.4-py3-none-any.whl
- Upload date:
- Size: 194.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ccc1dff6f3dd1e28c17b1a4d9d0a81847ae59a2bac8acdf6986c26926ac4f51 |
|
MD5 | 6c7a12c078b86f0f85c611dbcdee49c6 |
|
BLAKE2b-256 | d1e0ca8aa467e319bea278504f5ef4be231cca349ef8571f55e27686a53de0f3 |