ezbeq


Nameezbeq JSON
Version 0.3.9 PyPI version JSON
download
home_pagehttp://github.com/3ll3d00d/ezbeq
SummaryA small webapp which can send beqcatalogue filters to a DSP device
upload_time2021-04-11 10:58:43
maintainer
docs_urlNone
authorMatt Khan
requires_python>=3.7
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ezbeq

A simple web browser for [beqcatalogue](https://beqcatalogue.readthedocs.io/en/latest/) which integrates with [minidsp-rs](https://github.com/mrene/minidsp-rs)
for local remote control of a minidsp or HTP-1.

# Setup

## Windows / MacOS

Python is required so use an appropriate package manager to install it. 

[chocolatey](https://chocolatey.org/) is a convenient choice for Windows
[homebrew](https://docs.brew.sh/Installation) is the equivalent for MacOS

## Linux

Use your distro package manager to install python.

## Installation

Example is provided for rpi users

    $ ssh pi@myrpi
    $ sudo apt install python3 python3-venv python3-pip libyaml-dev
    $ mkdir python
    $ cd python
    $ python3 -m venv ezbeq
    $ cd ezbeq
    $ . bin/activate
    $ pip install ezbeq

### Using with a Minidsp

Install minidsp-rs as per the provided instructionshttps://github.com/mrene/minidsp-rs#installation

### Using with a Monolith HTP-1

See the configuration section below

## Upgrade

    $ ssh pi@myrpi
    $ cd python/ezbeq
    $ . bin/activate
    $ pip install --upgrade --force-reinstall ezbeq

then restart the app

## Running the app manually

    $ ssh pi@myrpi
    $ cd python/ezbeq
    $ . bin/activate
    $ ./bin/ezbeq
      Loading config from /home/pi/.ezbeq/ezbeq.yml
      2021-01-16 08:43:15,374 - twisted - INFO - __init__ - Serving ui from /home/pi/python/ezbeq/lib/python3.8/site-packages/ezbeq/ui

Now open http://youripaddress:8080/index.html in your browser 

## Configuration

See `$HOME/.ezbeq/ezbeq.yml`

Options that are intended for override are:

  * port: listens on port 8080 by default
  * if using a minidsp 
    * minidspExe: full path to the minidsp-rs app, defaults to minidsp so assumes the binary is already on your PATH
    * minidspOptions: additional command line switches to pass to the minidsp binary
  * if using a htp1, add the ip address and named channels to which the filters should be sent. e.g. if the HTP1 is at `192.168.1.181` and only sub1 should be updated 

```
htp1:
  ip: 192.168.1.181
  channels:
    - sub1
```

## Starting ezbeq on bootup

This is optional but recommended, it ensures the app starts automatically whenever the rpi boots up and makes
sure it restarts automatically if it ever crashes.

We will achieve this by creating and enabling a `systemd` service.

1) Create a file ezbeq.service in the appropriate location for your distro (e.g. ``/etc/systemd/system/`` for debian)::

```
[Unit]
Description=ezbeq
After=network.target

[Service]
Type=simple
User=myuser
WorkingDirectory=/home/pi
ExecStart=/home/pi/python/ezbeq/bin/ezbeq
Restart=always
RestartSec=1

[Install]
WantedBy=multi-user.target
```

2) enable the service and start it up::

```
$ sudo systemctl enable ezbeq.service
$ sudo service ezbeq start
$ sudo journalctl -u ezbeq.service
-- Logs begin at Sat 2019-08-17 12:17:02 BST, end at Sun 2019-08-18 21:58:43 BST. --
Aug 18 21:58:36 swoop systemd[1]: Started ezbeq.
```

3) reboot and repeat step 2 to verify the recorder has automatically started



            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/3ll3d00d/ezbeq",
    "name": "ezbeq",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Matt Khan",
    "author_email": "mattkhan+ezbeq@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/48/ba/07c247214fb4b37ee90e0a45f4e5a35a41ab838ff341e3e20d75f6d4c46a/ezbeq-0.3.9.tar.gz",
    "platform": "",
    "description": "# ezbeq\n\nA simple web browser for [beqcatalogue](https://beqcatalogue.readthedocs.io/en/latest/) which integrates with [minidsp-rs](https://github.com/mrene/minidsp-rs)\nfor local remote control of a minidsp or HTP-1.\n\n# Setup\n\n## Windows / MacOS\n\nPython is required so use an appropriate package manager to install it. \n\n[chocolatey](https://chocolatey.org/) is a convenient choice for Windows\n[homebrew](https://docs.brew.sh/Installation) is the equivalent for MacOS\n\n## Linux\n\nUse your distro package manager to install python.\n\n## Installation\n\nExample is provided for rpi users\n\n    $ ssh pi@myrpi\n    $ sudo apt install python3 python3-venv python3-pip libyaml-dev\n    $ mkdir python\n    $ cd python\n    $ python3 -m venv ezbeq\n    $ cd ezbeq\n    $ . bin/activate\n    $ pip install ezbeq\n\n### Using with a Minidsp\n\nInstall minidsp-rs as per the provided instructionshttps://github.com/mrene/minidsp-rs#installation\n\n### Using with a Monolith HTP-1\n\nSee the configuration section below\n\n## Upgrade\n\n    $ ssh pi@myrpi\n    $ cd python/ezbeq\n    $ . bin/activate\n    $ pip install --upgrade --force-reinstall ezbeq\n\nthen restart the app\n\n## Running the app manually\n\n    $ ssh pi@myrpi\n    $ cd python/ezbeq\n    $ . bin/activate\n    $ ./bin/ezbeq\n      Loading config from /home/pi/.ezbeq/ezbeq.yml\n      2021-01-16 08:43:15,374 - twisted - INFO - __init__ - Serving ui from /home/pi/python/ezbeq/lib/python3.8/site-packages/ezbeq/ui\n\nNow open http://youripaddress:8080/index.html in your browser \n\n## Configuration\n\nSee `$HOME/.ezbeq/ezbeq.yml`\n\nOptions that are intended for override are:\n\n  * port: listens on port 8080 by default\n  * if using a minidsp \n    * minidspExe: full path to the minidsp-rs app, defaults to minidsp so assumes the binary is already on your PATH\n    * minidspOptions: additional command line switches to pass to the minidsp binary\n  * if using a htp1, add the ip address and named channels to which the filters should be sent. e.g. if the HTP1 is at `192.168.1.181` and only sub1 should be updated \n\n```\nhtp1:\n  ip: 192.168.1.181\n  channels:\n    - sub1\n```\n\n## Starting ezbeq on bootup\n\nThis is optional but recommended, it ensures the app starts automatically whenever the rpi boots up and makes\nsure it restarts automatically if it ever crashes.\n\nWe will achieve this by creating and enabling a `systemd` service.\n\n1) Create a file ezbeq.service in the appropriate location for your distro (e.g. ``/etc/systemd/system/`` for debian)::\n\n```\n[Unit]\nDescription=ezbeq\nAfter=network.target\n\n[Service]\nType=simple\nUser=myuser\nWorkingDirectory=/home/pi\nExecStart=/home/pi/python/ezbeq/bin/ezbeq\nRestart=always\nRestartSec=1\n\n[Install]\nWantedBy=multi-user.target\n```\n\n2) enable the service and start it up::\n\n```\n$ sudo systemctl enable ezbeq.service\n$ sudo service ezbeq start\n$ sudo journalctl -u ezbeq.service\n-- Logs begin at Sat 2019-08-17 12:17:02 BST, end at Sun 2019-08-18 21:58:43 BST. --\nAug 18 21:58:36 swoop systemd[1]: Started ezbeq.\n```\n\n3) reboot and repeat step 2 to verify the recorder has automatically started\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A small webapp which can send beqcatalogue filters to a DSP device",
    "version": "0.3.9",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8a19cba7ddd9aaeda602927f2a7a8668",
                "sha256": "80779dc45e4e25b5f77bcaf86ef09c1d58e0d4693d6b73e0af31781d3c583591"
            },
            "downloads": -1,
            "filename": "ezbeq-0.3.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8a19cba7ddd9aaeda602927f2a7a8668",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 884622,
            "upload_time": "2021-04-11T10:58:42",
            "upload_time_iso_8601": "2021-04-11T10:58:42.510789Z",
            "url": "https://files.pythonhosted.org/packages/d2/1d/80946ddac3fd952bed09f31c474ea60b821c6eca71a2c6123d37f1bdb37f/ezbeq-0.3.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c6fd47354a544b651cb3e39c59066fa8",
                "sha256": "337c28dbf2e6f801825059c92b5d6ad07fb0e5fbe440c75c201b69e97b622c3b"
            },
            "downloads": -1,
            "filename": "ezbeq-0.3.9.tar.gz",
            "has_sig": false,
            "md5_digest": "c6fd47354a544b651cb3e39c59066fa8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 876874,
            "upload_time": "2021-04-11T10:58:43",
            "upload_time_iso_8601": "2021-04-11T10:58:43.720521Z",
            "url": "https://files.pythonhosted.org/packages/48/ba/07c247214fb4b37ee90e0a45f4e5a35a41ab838ff341e3e20d75f6d4c46a/ezbeq-0.3.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-11 10:58:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "3ll3d00d",
    "error": "Could not fetch GitHub repository",
    "lcname": "ezbeq"
}
        
Elapsed time: 0.32280s