# OpenRepos.net Web Client
[](https://gitlab.com/nobodyinperson/python3-openrepos/commits/master)
[](https://nobodyinperson.gitlab.io/python3-openrepos-webclient/coverage-report/)
[](https://nobodyinperson.gitlab.io/python3-openrepos-webclient)
[](https://badge.fury.io/py/openrepos-webclient)
`openrepos-webclient` is a Python package to interface the OpenRepos.net
website in an automated way.
## Installation
To install, run from the repository root:
```bash
python3 -m pip install --user .
```
or install it from [PyPi](https://pypi.org/project/openrepos):
```bash
python3 -m pip install --user openrepos
```
> (Run `sudo apt-get update && sudo apt-get -y install python3-pip && pip3 install --user -U pip` if it
complains about `pip` not being found)
You will also need to install at least one [`selenium`](https://selenium-python.readthedocs.io/)-compatible browser with webdriver, for example [Firefox](https://www.mozilla.org/de/firefox/new/) together with [`geckodriver`](https://github.com/mozilla/geckodriver).
If you want to run `openrepos` headlessly, you will also need [`Xvfb`](https://en.wikipedia.org/wiki/Xvfb).
## What can `openrepos` do?
> #### OpenRepos Credentials
>
> Define your [OpenRepos.net](https://openrepos.net) login credentials as environment variables.
> You can either run this in each terminal session once before running the `openrepos` command:
>
> ```bash
> export OPENREPOS_USERNAME=myuser OPENREPOS_PASSWORD=mypass
> ```
>
> ... or you can put the above in a file (say `openrepos-credentials.sh`) and then `source` this file, which is safer as you don't specify any credentials on the command-line:
>
> ```bash
> source openrepos-credentials.sh
> ```
>
> #### Executing
>
> If running just `openrepos` errors out with something like `command not found`, then just run `python3 -m openrepos` instead.
### Create a new app
This command creates a new SailfishOS app `TestApp` in the `Libraries` category.
```bash
openrepos -i new-app -n TestApp -p SailfishOS -c Libraries
```
### Upload RPMs to an app
This command uploads all RPMs in the current directory to an app on OpenRepos called `TestApp`:
```bash
openrepos upload-rpm -n TestApp *.rpm
```
If you want to create the app if it doesn't exist yet, you have to provide the same metadata as above for `new-app`:
```bash
openrepos upload-rpm -n TestApp -p SailfishOS -c Libraries *.rpm
```
### Delete an App
This delete a `TestApp`:
```bash
openrepos delete-app -n TestApp
```
## Using this to automate uploading RPMs to OpenRepos in GitLab CI
This package was designed to automate RPM upload to [OpenRepos.net](https://openrepos.net).
To do that in GitLab CI, you can `include` the file [`openrepos-upload-rpm.gitlab-ci.yml`](https://gitlab.com/nobodyinperson/python3-openrepos-webclient/-/blob/master/openrepos-upload-rpm.gitlab-ci.yml) from this repository in your CI config.
The file contains an example of how to do that.
## Troubleshooting
If you experience problems and want to debug them, you can run `openrepos` interactively (`--interacitve`) and verbosely (`-vvv`):
```bash
openrepos --interactive -vvv upload-rpm ...
```
This will ask you before every step and tell you what's going on.
To run without opening the browser window (like in CI), run it with `--xvfb`:
```bash
openrepos --xvfb --interactive -vvv upload-rpm ...
```
## Documentation
Documentation of the `openrepos` package can be found [here on
GitLab](https://nobodyinperson.gitlab.io/python3-openrepos/).
Also, the command-line help page `openrepos -h` is your friend.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/nobodyinperson/python3-openrepos-webclient",
"name": "openrepos-webclient",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "openrepos,openrepos.net,sailfish,sailfishos,selenium,firefox,xvfb",
"author": "Yann Buechau",
"author_email": "nobodyinperson@posteo.de",
"download_url": "https://files.pythonhosted.org/packages/87/f9/dbf05725710caaf0df8d124def80945ef174fd1579674b525a00ee689c86/openrepos-webclient-1.5.1.tar.gz",
"platform": null,
"description": "# OpenRepos.net Web Client\n\n[](https://gitlab.com/nobodyinperson/python3-openrepos/commits/master)\n[](https://nobodyinperson.gitlab.io/python3-openrepos-webclient/coverage-report/)\n[](https://nobodyinperson.gitlab.io/python3-openrepos-webclient)\n[](https://badge.fury.io/py/openrepos-webclient)\n\n`openrepos-webclient` is a Python package to interface the OpenRepos.net\nwebsite in an automated way.\n\n## Installation\n\nTo install, run from the repository root:\n\n```bash\npython3 -m pip install --user .\n```\n\nor install it from [PyPi](https://pypi.org/project/openrepos):\n\n```bash\npython3 -m pip install --user openrepos\n```\n\n> (Run `sudo apt-get update && sudo apt-get -y install python3-pip && pip3 install --user -U pip` if it\ncomplains about `pip` not being found)\n\nYou will also need to install at least one [`selenium`](https://selenium-python.readthedocs.io/)-compatible browser with webdriver, for example [Firefox](https://www.mozilla.org/de/firefox/new/) together with [`geckodriver`](https://github.com/mozilla/geckodriver).\n\nIf you want to run `openrepos` headlessly, you will also need [`Xvfb`](https://en.wikipedia.org/wiki/Xvfb).\n\n## What can `openrepos` do?\n\n> #### OpenRepos Credentials\n>\n> Define your [OpenRepos.net](https://openrepos.net) login credentials as environment variables.\n> You can either run this in each terminal session once before running the `openrepos` command:\n>\n> ```bash\n> export OPENREPOS_USERNAME=myuser OPENREPOS_PASSWORD=mypass\n> ```\n>\n> ... or you can put the above in a file (say `openrepos-credentials.sh`) and then `source` this file, which is safer as you don't specify any credentials on the command-line:\n>\n> ```bash\n> source openrepos-credentials.sh\n> ```\n>\n> #### Executing\n>\n> If running just `openrepos` errors out with something like `command not found`, then just run `python3 -m openrepos` instead.\n\n### Create a new app\n\nThis command creates a new SailfishOS app `TestApp` in the `Libraries` category.\n\n```bash\nopenrepos -i new-app -n TestApp -p SailfishOS -c Libraries\n```\n\n### Upload RPMs to an app\n\nThis command uploads all RPMs in the current directory to an app on OpenRepos called `TestApp`:\n\n```bash\nopenrepos upload-rpm -n TestApp *.rpm\n```\n\nIf you want to create the app if it doesn't exist yet, you have to provide the same metadata as above for `new-app`:\n\n```bash\nopenrepos upload-rpm -n TestApp -p SailfishOS -c Libraries *.rpm\n```\n\n### Delete an App\n\nThis delete a `TestApp`:\n\n```bash\nopenrepos delete-app -n TestApp\n```\n\n## Using this to automate uploading RPMs to OpenRepos in GitLab CI\n\nThis package was designed to automate RPM upload to [OpenRepos.net](https://openrepos.net).\nTo do that in GitLab CI, you can `include` the file [`openrepos-upload-rpm.gitlab-ci.yml`](https://gitlab.com/nobodyinperson/python3-openrepos-webclient/-/blob/master/openrepos-upload-rpm.gitlab-ci.yml) from this repository in your CI config.\nThe file contains an example of how to do that.\n\n## Troubleshooting\n\nIf you experience problems and want to debug them, you can run `openrepos` interactively (`--interacitve`) and verbosely (`-vvv`):\n\n```bash\nopenrepos --interactive -vvv upload-rpm ...\n```\n\nThis will ask you before every step and tell you what's going on.\n\nTo run without opening the browser window (like in CI), run it with `--xvfb`:\n\n```bash\nopenrepos --xvfb --interactive -vvv upload-rpm ...\n```\n\n\n## Documentation\n\nDocumentation of the `openrepos` package can be found [here on\nGitLab](https://nobodyinperson.gitlab.io/python3-openrepos/).\n\nAlso, the command-line help page `openrepos -h` is your friend.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "OpenRepos.net web client",
"version": "1.5.1",
"project_urls": {
"Homepage": "https://gitlab.com/nobodyinperson/python3-openrepos-webclient"
},
"split_keywords": [
"openrepos",
"openrepos.net",
"sailfish",
"sailfishos",
"selenium",
"firefox",
"xvfb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87f9dbf05725710caaf0df8d124def80945ef174fd1579674b525a00ee689c86",
"md5": "e901c772f5d0384da462acc03e331b10",
"sha256": "9382d72bc37eaaa0753deea24a18daa0272282eed2071eb8fd0a5c6675e75656"
},
"downloads": -1,
"filename": "openrepos-webclient-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "e901c772f5d0384da462acc03e331b10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24881,
"upload_time": "2023-06-09T16:03:14",
"upload_time_iso_8601": "2023-06-09T16:03:14.930080Z",
"url": "https://files.pythonhosted.org/packages/87/f9/dbf05725710caaf0df8d124def80945ef174fd1579674b525a00ee689c86/openrepos-webclient-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-09 16:03:14",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "nobodyinperson",
"gitlab_project": "python3-openrepos-webclient",
"lcname": "openrepos-webclient"
}
JSON