diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-29 10:19:10 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-29 10:19:10 +0000 |
| commit | 9ae4e32db4089115abe22a4b81e37eb8034d8b82 (patch) | |
| tree | a2ccf81000c304720991393ee6af7b92156207aa | |
| parent | 7d36840409a141b6f282a0998e01b406dfb3b709 (diff) | |
automatic import of python-rfhub2
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-rfhub2.spec | 413 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 415 insertions, 0 deletions
@@ -0,0 +1 @@ +/rfhub2-0.30.tar.gz diff --git a/python-rfhub2.spec b/python-rfhub2.spec new file mode 100644 index 0000000..abfc9f1 --- /dev/null +++ b/python-rfhub2.spec @@ -0,0 +1,413 @@ +%global _empty_manifest_terminate_build 0 +Name: python-rfhub2 +Version: 0.30 +Release: 1 +Summary: Webserver for robot framework and python assets documentation +License: Apache License 2.0 +URL: https://github.com/pbylicki/rfhub2/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/65/99/3d1830cc062c9e386cc9ccc8b462029e034426b3a2d7897f7fb87b3c0ead/rfhub2-0.30.tar.gz +BuildArch: noarch + +Requires: python3-alembic +Requires: python3-aiofiles +Requires: python3-Click +Requires: python3-fastapi +Requires: python3-pydantic +Requires: python3-robotframework +Requires: python3-SQLAlchemy +Requires: python3-requests +Requires: python3-uvicorn +Requires: python3-progress +Requires: python3-psycopg2-binary + +%description +# 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) + + + + +%package -n python3-rfhub2 +Summary: Webserver for robot framework and python assets documentation +Provides: python-rfhub2 +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-rfhub2 +# 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) + + + + +%package help +Summary: Development documents and examples for rfhub2 +Provides: python3-rfhub2-doc +%description help +# 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) + + + + +%prep +%autosetup -n rfhub2-0.30 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-rfhub2 -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 29 2023 Python_Bot <Python_Bot@openeuler.org> - 0.30-1 +- Package Spec generated @@ -0,0 +1 @@ +d3a53ed7321ef67533af801c170a7bab rfhub2-0.30.tar.gz |