# Main Menu Shell for Openvario
[](https://app.circleci.com/pipelines/github/kedder/openvario-shell/)
[](https://coveralls.io/github/kedder/openvario-shell)
[](http://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://codeclimate.com/github/kedder/openvario-shell/maintainability)
This is a replacement for stock main menu shipped with official
[Openvario](https://openvario.org/) images. It is implemented in Python and
offers more extensibility and richer user interface than stock shell
script-based one.
The goal of this project is to provide a user interface for managing Openvario
device that is:
* **User friendly** -- responsive, can be operated with remote stick or
minimal input controls.
* **Feature rich** -- allow to manage all aspects of device, including
connected devices, files, etc.
* **Extensible** -- allow to integrate third-party applications.
* **Simple to develop and test** -- written in Python, can be tested without
Openvario device at hand.
## Features
* Run XCSoar, optionally automatically after configurable timeout
* Pick preferred XCSoar language
* Chose screen orientation, screen brightness, font size and more
* Calibrate touchscreen and sensors
* Download flight logs to USB flash drive with responsive UI
* Copy files to and from USB flash drive, backup and restore configuration
* Synchronize system time with GPS time (when GPS receiver is connected)
* Integrate with third party apps (like [Competition Manager](https://github.com/kedder/openvario-compman))
## Installation
The easiest way to install is using `opkg` package manager on
internet-connected Openvario device.
```sh
wget https://raw.githubusercontent.com/kedder/openvario-shell/master/scripts/openvario-shell-install.sh -O - | sh
```
After executing this command, `ovshell` command should be available. It will
start automatically next time Openvario boots up.
In case you didn't like it and would like to return to stock Openvario menu,
run this command:
```sh
wget https://raw.githubusercontent.com/kedder/openvario-shell/master/scripts/openvario-shell-uninstall.sh -O - | sh
```
## Development
It is not required to own or have access to Openvario device in order to
develop `ovshell`. The only requirements are Python 3.7 or higher and terminal
emulator, readily available on MacOS or Linux operating systems. There are lots
of free options for Windows as well.
### Setting up the development environment
`ovshell` uses `pipenv` for managing dependencies and dev environment. If you
don't have it yet, install with:
```sh
pip install pipenv # or pip3 if you don't have "pip"
```
After checking out the sources, `cd` to `openvario-shell` directory and run:
```sh
pipenv shell
pipenv sync
```
After that, your development environment is ready, you should be able to run
the app:
```sh
ovshell
```
It is possible to adjust few options by providing them in `.env` file, located
in project directory. You can copy the sample file `sample.env` to `.env` and
adjust values there.
### Development tools
`ovshell` uses various tools to check the code quality. They are generally
available through `make` program. Most useful are these:
* `make test` - runs the test suite
* `make coverage` - runs the test suite and display test coverage statistics
* `make mypy` - checks the sources with static type checker
* `make black` - reformats the source code to match the code style
Raw data
{
"_id": null,
"home_page": "https://github.com/kedder/openvario-shell",
"name": "openvario-shell",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": "",
"keywords": "openvario tui menu shell",
"author": "Andrey Lebedev",
"author_email": "andrey.lebedev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6a/ff/1657328f507b97a7f737bc66e385fa41927ff10a7318cac42e81677a02b6/openvario-shell-0.7.8.tar.gz",
"platform": null,
"description": "# Main Menu Shell for Openvario\n\n[](https://app.circleci.com/pipelines/github/kedder/openvario-shell/)\n[](https://coveralls.io/github/kedder/openvario-shell)\n[](http://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://codeclimate.com/github/kedder/openvario-shell/maintainability)\n\nThis is a replacement for stock main menu shipped with official\n[Openvario](https://openvario.org/) images. It is implemented in Python and\noffers more extensibility and richer user interface than stock shell\nscript-based one.\n\nThe goal of this project is to provide a user interface for managing Openvario\ndevice that is:\n\n* **User friendly** -- responsive, can be operated with remote stick or\n minimal input controls.\n* **Feature rich** -- allow to manage all aspects of device, including\n connected devices, files, etc.\n* **Extensible** -- allow to integrate third-party applications.\n* **Simple to develop and test** -- written in Python, can be tested without\n Openvario device at hand.\n\n## Features\n\n\n\n* Run XCSoar, optionally automatically after configurable timeout\n* Pick preferred XCSoar language\n* Chose screen orientation, screen brightness, font size and more\n* Calibrate touchscreen and sensors\n* Download flight logs to USB flash drive with responsive UI\n* Copy files to and from USB flash drive, backup and restore configuration\n* Synchronize system time with GPS time (when GPS receiver is connected)\n* Integrate with third party apps (like [Competition Manager](https://github.com/kedder/openvario-compman))\n\n## Installation\n\nThe easiest way to install is using `opkg` package manager on\ninternet-connected Openvario device.\n\n```sh\nwget https://raw.githubusercontent.com/kedder/openvario-shell/master/scripts/openvario-shell-install.sh -O - | sh\n```\n\nAfter executing this command, `ovshell` command should be available. It will\nstart automatically next time Openvario boots up.\n\nIn case you didn't like it and would like to return to stock Openvario menu,\nrun this command:\n\n```sh\nwget https://raw.githubusercontent.com/kedder/openvario-shell/master/scripts/openvario-shell-uninstall.sh -O - | sh\n```\n\n## Development\n\nIt is not required to own or have access to Openvario device in order to\ndevelop `ovshell`. The only requirements are Python 3.7 or higher and terminal\nemulator, readily available on MacOS or Linux operating systems. There are lots\nof free options for Windows as well.\n\n### Setting up the development environment\n\n`ovshell` uses `pipenv` for managing dependencies and dev environment. If you\ndon't have it yet, install with:\n\n```sh\npip install pipenv # or pip3 if you don't have \"pip\"\n```\n\nAfter checking out the sources, `cd` to `openvario-shell` directory and run:\n\n```sh\npipenv shell\npipenv sync\n```\n\nAfter that, your development environment is ready, you should be able to run\nthe app:\n\n```sh\novshell\n```\n\nIt is possible to adjust few options by providing them in `.env` file, located\nin project directory. You can copy the sample file `sample.env` to `.env` and\nadjust values there.\n\n### Development tools\n\n`ovshell` uses various tools to check the code quality. They are generally\navailable through `make` program. Most useful are these:\n\n* `make test` - runs the test suite\n* `make coverage` - runs the test suite and display test coverage statistics\n* `make mypy` - checks the sources with static type checker\n* `make black` - reformats the source code to match the code style\n",
"bugtrack_url": null,
"license": "",
"summary": "Main Menu Shell for OpenVario",
"version": "0.7.8",
"split_keywords": [
"openvario",
"tui",
"menu",
"shell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6aff1657328f507b97a7f737bc66e385fa41927ff10a7318cac42e81677a02b6",
"md5": "e7967353eb068eb7117cbe3ab890611a",
"sha256": "7220079f04b5c25ae59094022c5f37da5fa48c2b0fc6c09713817567e0830abe"
},
"downloads": -1,
"filename": "openvario-shell-0.7.8.tar.gz",
"has_sig": false,
"md5_digest": "e7967353eb068eb7117cbe3ab890611a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 86486,
"upload_time": "2023-01-17T21:03:15",
"upload_time_iso_8601": "2023-01-17T21:03:15.295014Z",
"url": "https://files.pythonhosted.org/packages/6a/ff/1657328f507b97a7f737bc66e385fa41927ff10a7318cac42e81677a02b6/openvario-shell-0.7.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 21:03:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kedder",
"github_project": "openvario-shell",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "openvario-shell"
}
JSON
