diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-openremote-cli.spec | 476 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 478 insertions, 0 deletions
@@ -0,0 +1 @@ +/openremote_cli-0.6.63.tar.gz diff --git a/python-openremote-cli.spec b/python-openremote-cli.spec new file mode 100644 index 0000000..fc0848a --- /dev/null +++ b/python-openremote-cli.spec @@ -0,0 +1,476 @@ +%global _empty_manifest_terminate_build 0 +Name: python-openremote-cli +Version: 0.6.63 +Release: 1 +Summary: OpenRemote Command-line interface +License: AGPLv3 +URL: https://www.openremote.io +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/41/e2/06eb1b550d4522cd26f75fa584745d8dc00125b6eed4a7d662a9a6c3ff63/openremote_cli-0.6.63.tar.gz +BuildArch: noarch + +Requires: python3-requests +Requires: python3-wget +Requires: python3-keycloak +Requires: python3-emojis +Requires: python3-oronium + +%description + + +[](https://github.com/psf/black) +[](https://github.com/pre-commit/pre-commit) +[](https://github.com/Naereen/badges/) +[](https://www.paypal.com/webapps/shoppingcart?flowlogging_id=4b5432e8ad1a8&mfid=1616517920020_4b5432e8ad1a8#/checkout/openButton) + +# OpenRemote CLI + +## Intro + +This is Command Line Interface to OpenRemote IoT platform. It's purpose is to reduce friction of using OpenRemote by Do It Yourself users. + +It is published as a Python package on [PyPi.org](https://pypi.org/project/openremote-cli/) + +## About OR + +OpenRemote is a great real OpenSource IoT platform. + +## Usage + +To install/upgrade the CLI: +```bash +pip install --upgrade openremote-cli +or --version +``` + +## Docker image + +There is also docker image with embedded openremote-cli and other tools used during +stack management, like `python`, `aws` or `docker-compose`. Therefore, `docker` is +the only tool installed when you need to work on remote host. Example: + +``` +% docker run -ti --rm openremote/openremote-cli -V +openremote-cli/0.6.46 3.8.10 (default, May 12 2021, 15:56:47) [GCC 8.3.0] Linux/#1 SMP Tue Mar 23 09:27:39 UTC 202 +% docker run -ti --rm --entrypoint bash -v ~/.aws:/root/.aws openremote/openremote-cli +root@4438b25d0834:/# aws --version +aws-cli/2.1.39 Python/3.8.8 Linux/5.10.25-linuxkit exe/x86_64.debian.10 prompt/off +``` + +### Deploy local OpenRemote stack + +```bash +or deploy +``` + +When it finishes you should be able to open https://localhost and login with admin:secret to the manager. Depending on your machine it can take few minutes to +start or services (usually less than 10 minutes). If it does not work yet, check it with ```docker ps``` to see if all services are in healthy or starting stage. + +### Remove local OpenRemote stack + +```bash +or deploy --action remove +``` + +### Deploy OpenRemote stack on AWS with DNS entry + +```bash +or deploy --platform aws --dnsname myiot.mydomain.com +``` +### Check health of the openremote stack +```bash +or deploy -a health --dnsname myiot.mydomain.com -v +``` + +### Install shell completion extension + +#### zsh + +```bash +TODO +``` + +#### bash + +``` +TODO +``` + +## Configure existing OpenRemote instance + +### Add users + +### Add assets + +### Add customization + +## Develop openremote-cli + +Following tools are used: +- python (pip, poetry, black, PyPI.org) +- git (pre-commit, actions) +- docker (docker-compose, swarm) +- AWS (CloudFormation) +- make + +`poetry run openremote-cli -V` +### Adding feature + +In this project we use Behavior-driven development (or BDD). BDD is an agile +software development technique that encourages collaboration between developers, +QA and non-technical or business participants in a software project. + +This project uses Gherkin to define what features which should be covered. Features +files can be generated by people on manager level or even higher. An example +of file defining a feature: + +```gherkin +Feature: deploy + + Scenario: deploy to localhost + Given we have docker and docker-compose installed + When we call openremote-cli --dry-run deploy --action create + Then show what will be done +``` + +When the feature is implemented it can be checked with behave: + +```bash +> behave +Feature: deploy # features/deploy.feature:1 + + Scenario: deploy to localhost # features/deploy.feature:3 + Given we have docker and docker-compose installed # features/steps/deploy_steps.py:8 0.453s + When we call openremote-cli --dry-run deploy --action create # features/steps/deploy_steps.py:16 0.591s + Then show what will be done # features/steps/deploy_steps.py:24 0.000s + +1 feature passed, 0 failed, 0 skipped +1 scenario passed, 0 failed, 0 skipped +3 steps passed, 0 failed, 0 skipped, 0 undefined +Took 0m1.044s +``` + + +%package -n python3-openremote-cli +Summary: OpenRemote Command-line interface +Provides: python-openremote-cli +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-openremote-cli + + +[](https://github.com/psf/black) +[](https://github.com/pre-commit/pre-commit) +[](https://github.com/Naereen/badges/) +[](https://www.paypal.com/webapps/shoppingcart?flowlogging_id=4b5432e8ad1a8&mfid=1616517920020_4b5432e8ad1a8#/checkout/openButton) + +# OpenRemote CLI + +## Intro + +This is Command Line Interface to OpenRemote IoT platform. It's purpose is to reduce friction of using OpenRemote by Do It Yourself users. + +It is published as a Python package on [PyPi.org](https://pypi.org/project/openremote-cli/) + +## About OR + +OpenRemote is a great real OpenSource IoT platform. + +## Usage + +To install/upgrade the CLI: +```bash +pip install --upgrade openremote-cli +or --version +``` + +## Docker image + +There is also docker image with embedded openremote-cli and other tools used during +stack management, like `python`, `aws` or `docker-compose`. Therefore, `docker` is +the only tool installed when you need to work on remote host. Example: + +``` +% docker run -ti --rm openremote/openremote-cli -V +openremote-cli/0.6.46 3.8.10 (default, May 12 2021, 15:56:47) [GCC 8.3.0] Linux/#1 SMP Tue Mar 23 09:27:39 UTC 202 +% docker run -ti --rm --entrypoint bash -v ~/.aws:/root/.aws openremote/openremote-cli +root@4438b25d0834:/# aws --version +aws-cli/2.1.39 Python/3.8.8 Linux/5.10.25-linuxkit exe/x86_64.debian.10 prompt/off +``` + +### Deploy local OpenRemote stack + +```bash +or deploy +``` + +When it finishes you should be able to open https://localhost and login with admin:secret to the manager. Depending on your machine it can take few minutes to +start or services (usually less than 10 minutes). If it does not work yet, check it with ```docker ps``` to see if all services are in healthy or starting stage. + +### Remove local OpenRemote stack + +```bash +or deploy --action remove +``` + +### Deploy OpenRemote stack on AWS with DNS entry + +```bash +or deploy --platform aws --dnsname myiot.mydomain.com +``` +### Check health of the openremote stack +```bash +or deploy -a health --dnsname myiot.mydomain.com -v +``` + +### Install shell completion extension + +#### zsh + +```bash +TODO +``` + +#### bash + +``` +TODO +``` + +## Configure existing OpenRemote instance + +### Add users + +### Add assets + +### Add customization + +## Develop openremote-cli + +Following tools are used: +- python (pip, poetry, black, PyPI.org) +- git (pre-commit, actions) +- docker (docker-compose, swarm) +- AWS (CloudFormation) +- make + +`poetry run openremote-cli -V` +### Adding feature + +In this project we use Behavior-driven development (or BDD). BDD is an agile +software development technique that encourages collaboration between developers, +QA and non-technical or business participants in a software project. + +This project uses Gherkin to define what features which should be covered. Features +files can be generated by people on manager level or even higher. An example +of file defining a feature: + +```gherkin +Feature: deploy + + Scenario: deploy to localhost + Given we have docker and docker-compose installed + When we call openremote-cli --dry-run deploy --action create + Then show what will be done +``` + +When the feature is implemented it can be checked with behave: + +```bash +> behave +Feature: deploy # features/deploy.feature:1 + + Scenario: deploy to localhost # features/deploy.feature:3 + Given we have docker and docker-compose installed # features/steps/deploy_steps.py:8 0.453s + When we call openremote-cli --dry-run deploy --action create # features/steps/deploy_steps.py:16 0.591s + Then show what will be done # features/steps/deploy_steps.py:24 0.000s + +1 feature passed, 0 failed, 0 skipped +1 scenario passed, 0 failed, 0 skipped +3 steps passed, 0 failed, 0 skipped, 0 undefined +Took 0m1.044s +``` + + +%package help +Summary: Development documents and examples for openremote-cli +Provides: python3-openremote-cli-doc +%description help + + +[](https://github.com/psf/black) +[](https://github.com/pre-commit/pre-commit) +[](https://github.com/Naereen/badges/) +[](https://www.paypal.com/webapps/shoppingcart?flowlogging_id=4b5432e8ad1a8&mfid=1616517920020_4b5432e8ad1a8#/checkout/openButton) + +# OpenRemote CLI + +## Intro + +This is Command Line Interface to OpenRemote IoT platform. It's purpose is to reduce friction of using OpenRemote by Do It Yourself users. + +It is published as a Python package on [PyPi.org](https://pypi.org/project/openremote-cli/) + +## About OR + +OpenRemote is a great real OpenSource IoT platform. + +## Usage + +To install/upgrade the CLI: +```bash +pip install --upgrade openremote-cli +or --version +``` + +## Docker image + +There is also docker image with embedded openremote-cli and other tools used during +stack management, like `python`, `aws` or `docker-compose`. Therefore, `docker` is +the only tool installed when you need to work on remote host. Example: + +``` +% docker run -ti --rm openremote/openremote-cli -V +openremote-cli/0.6.46 3.8.10 (default, May 12 2021, 15:56:47) [GCC 8.3.0] Linux/#1 SMP Tue Mar 23 09:27:39 UTC 202 +% docker run -ti --rm --entrypoint bash -v ~/.aws:/root/.aws openremote/openremote-cli +root@4438b25d0834:/# aws --version +aws-cli/2.1.39 Python/3.8.8 Linux/5.10.25-linuxkit exe/x86_64.debian.10 prompt/off +``` + +### Deploy local OpenRemote stack + +```bash +or deploy +``` + +When it finishes you should be able to open https://localhost and login with admin:secret to the manager. Depending on your machine it can take few minutes to +start or services (usually less than 10 minutes). If it does not work yet, check it with ```docker ps``` to see if all services are in healthy or starting stage. + +### Remove local OpenRemote stack + +```bash +or deploy --action remove +``` + +### Deploy OpenRemote stack on AWS with DNS entry + +```bash +or deploy --platform aws --dnsname myiot.mydomain.com +``` +### Check health of the openremote stack +```bash +or deploy -a health --dnsname myiot.mydomain.com -v +``` + +### Install shell completion extension + +#### zsh + +```bash +TODO +``` + +#### bash + +``` +TODO +``` + +## Configure existing OpenRemote instance + +### Add users + +### Add assets + +### Add customization + +## Develop openremote-cli + +Following tools are used: +- python (pip, poetry, black, PyPI.org) +- git (pre-commit, actions) +- docker (docker-compose, swarm) +- AWS (CloudFormation) +- make + +`poetry run openremote-cli -V` +### Adding feature + +In this project we use Behavior-driven development (or BDD). BDD is an agile +software development technique that encourages collaboration between developers, +QA and non-technical or business participants in a software project. + +This project uses Gherkin to define what features which should be covered. Features +files can be generated by people on manager level or even higher. An example +of file defining a feature: + +```gherkin +Feature: deploy + + Scenario: deploy to localhost + Given we have docker and docker-compose installed + When we call openremote-cli --dry-run deploy --action create + Then show what will be done +``` + +When the feature is implemented it can be checked with behave: + +```bash +> behave +Feature: deploy # features/deploy.feature:1 + + Scenario: deploy to localhost # features/deploy.feature:3 + Given we have docker and docker-compose installed # features/steps/deploy_steps.py:8 0.453s + When we call openremote-cli --dry-run deploy --action create # features/steps/deploy_steps.py:16 0.591s + Then show what will be done # features/steps/deploy_steps.py:24 0.000s + +1 feature passed, 0 failed, 0 skipped +1 scenario passed, 0 failed, 0 skipped +3 steps passed, 0 failed, 0 skipped, 0 undefined +Took 0m1.044s +``` + + +%prep +%autosetup -n openremote-cli-0.6.63 + +%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-openremote-cli -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6.63-1 +- Package Spec generated @@ -0,0 +1 @@ +c4bfb294827ef43d3e45333245d32b9e openremote_cli-0.6.63.tar.gz |