# OnSign TV App Simulator
This simulator makes it easier to develop [OnSign TV Apps][1] by testing your configuration locally, without having to upload your HTML to OnSign TV every time you make a change while developing your app.
## Installing
This simulator requires Python 3.7 and up. You can optionally install [ffmpeg][2] to determine the duration of video and audio files, but that is not needed unless you plan on using those attributes on your app. If you want ID3 information for audio files, you'll also need to install [mutagen][3].
### Installing from [PyPI](https://pypi.org/)
You can easily install it from PyPI:
```
pip install onsigntv-app-simulator
```
### Installing from this repo
You can also install it from this repo.
After cloning or downloading this repo, just enter the folder, create a new environment and install it.
```
python3 -m venv env
. env/bin/activate
python setup.py install
```
## Using the Simulator
After installing, running the simulator is very simple. The following command should be in your path:
```
onsigntv-app-simulator path/to/apps
```
If you don't specify a path, the app simulator will use your current working directory.
After running, open your browser and navigate to <http://127.0.01:8080/>. Click on your template file, fill in the options and start developing.
The app simulator will automatically track files – like images, CSS or Javascript - used by your app. If any file used changes the app will be automatically reloaded.
> **Heads Up!** If you installed the simulator in a `virtualenv` the command should be running with the `virtualenv` activated!
Report any issues you find [here][4] and keep on working on your apps!
[1]: https://github.com/onsigntv/apps
[2]: https://ffmpeg.org/download.html
[3]: https://mutagen.readthedocs.org
[4]: https://github.com/onsigntv/app-simulator/issues
Raw data
{
"_id": null,
"home_page": "https://github.com/onsigntv/app-simulator",
"name": "onsigntv-app-simulator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "development onsigntv apps",
"author": "OnSign TV",
"author_email": "support@onsign.tv",
"download_url": "https://files.pythonhosted.org/packages/51/07/aca6acc5d8239445651f5afcb6f0498a2b5d0285e0e0ff89389b8a3d6a68/onsigntv-app-simulator-1.2.0.tar.gz",
"platform": null,
"description": "# OnSign TV App Simulator\n\nThis simulator makes it easier to develop [OnSign TV Apps][1] by testing your configuration locally, without having to upload your HTML to OnSign TV every time you make a change while developing your app.\n\n\n## Installing\n\nThis simulator requires Python 3.7 and up. You can optionally install [ffmpeg][2] to determine the duration of video and audio files, but that is not needed unless you plan on using those attributes on your app. If you want ID3 information for audio files, you'll also need to install [mutagen][3].\n\n\n### Installing from [PyPI](https://pypi.org/)\n\nYou can easily install it from PyPI:\n\n```\npip install onsigntv-app-simulator\n```\n\n\n### Installing from this repo\n\nYou can also install it from this repo.\n\nAfter cloning or downloading this repo, just enter the folder, create a new environment and install it.\n\n```\npython3 -m venv env\n. env/bin/activate\n\npython setup.py install\n```\n\n\n## Using the Simulator\n\nAfter installing, running the simulator is very simple. The following command should be in your path:\n\n```\nonsigntv-app-simulator path/to/apps\n```\n\nIf you don't specify a path, the app simulator will use your current working directory.\n\nAfter running, open your browser and navigate to <http://127.0.01:8080/>. Click on your template file, fill in the options and start developing.\n\nThe app simulator will automatically track files \u2013 like images, CSS or Javascript - used by your app. If any file used changes the app will be automatically reloaded.\n\n> **Heads Up!** If you installed the simulator in a `virtualenv` the command should be running with the `virtualenv` activated!\n\nReport any issues you find [here][4] and keep on working on your apps!\n\n\n[1]: https://github.com/onsigntv/apps\n[2]: https://ffmpeg.org/download.html\n[3]: https://mutagen.readthedocs.org\n[4]: https://github.com/onsigntv/app-simulator/issues\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Assist the development of apps for OnSign TV platform by running them locally.",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/onsigntv/app-simulator/issues",
"Homepage": "https://github.com/onsigntv/app-simulator"
},
"split_keywords": [
"development",
"onsigntv",
"apps"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e847d11ed495bea49bfccb30eac69fa4816cc8eb7cba58b73c0a2b67e77f189a",
"md5": "6812f89cd9fe63a64f4541c93740dcac",
"sha256": "8e96c4d8a54cede00b3ec7937aa4e87c6e39466486dc23920a2e1e40cacb5349"
},
"downloads": -1,
"filename": "onsigntv_app_simulator-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6812f89cd9fe63a64f4541c93740dcac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 71026,
"upload_time": "2023-06-16T21:24:24",
"upload_time_iso_8601": "2023-06-16T21:24:24.589901Z",
"url": "https://files.pythonhosted.org/packages/e8/47/d11ed495bea49bfccb30eac69fa4816cc8eb7cba58b73c0a2b67e77f189a/onsigntv_app_simulator-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5107aca6acc5d8239445651f5afcb6f0498a2b5d0285e0e0ff89389b8a3d6a68",
"md5": "39bc4942b490f90f478693a2fdd93569",
"sha256": "b9bffb36a2f94072778e665bc3857962467f85a86f6e80899ac563a3b5fc16f4"
},
"downloads": -1,
"filename": "onsigntv-app-simulator-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "39bc4942b490f90f478693a2fdd93569",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 67657,
"upload_time": "2023-06-16T21:24:26",
"upload_time_iso_8601": "2023-06-16T21:24:26.122056Z",
"url": "https://files.pythonhosted.org/packages/51/07/aca6acc5d8239445651f5afcb6f0498a2b5d0285e0e0ff89389b8a3d6a68/onsigntv-app-simulator-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 21:24:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "onsigntv",
"github_project": "app-simulator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "onsigntv-app-simulator"
}
JSON
