| Name | mythme JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | Find and record programs on MythTV |
| upload_time | 2024-10-27 00:02:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 Donald Oakes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
mythtv
canned
search
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mythme
**Find and record programs on MythTV**
Inspired by [MythWeb](https://github.com/MythTV/mythweb)'s Canned Searches feature, mythme makes it easy
to create and save custom queries. For example, a query named `Horror Movies of the 1930s`:
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/query-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/query-light.png">
<img alt="mythme query" src="https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/query-light.png">
</picture>
The result after clicking Save:
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/programs-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/programs-light.png">
<img alt="mythme programs" src="https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/programs-light.png">
</picture>
## Prerequisites
- python 3
- mariadb connector/c
## Installation
This installs to a local virtual environment.
```
python -m venv ~/.local --system-site-packages
~/.local/bin/pip install mythme
```
## Environment variable
The MYTHME_DIR environment variable points to a directory where mythme
stores saved queries and other items. It's also where you can create a mythme.yaml
file to [configure](#configuration) mythme.
```
export MYTHME_DIR="~/.mythme"
```
(default is `~/.mythme`)
## Configuration
In many cases no configuration is required. This is especially true if you're
running mythme on MythTV's master backend host.
### Database
For [Database Configuration](https://www.mythtv.org/wiki/Config.xml#Database),
mythme looks for `~/.mythtv/config.xml` and uses the `<Database>` element if present.
### MythTV API server
To determine the [MythTV Services API](https://www.mythtv.org/wiki/Services_API) host, mythme tries
`BackendServerAddr` and `BackendStatusPort` from MythTV's `settings` db table.
### Custom config
Settings specified in `$MYTHME_DIR/mythme.yaml` override the autoconfig values above.
Here's an example mythme.yaml:
```yaml
database:
host: '192.168.0.70'
port: 3306
database: mythconverg
username: mythtv
password: mythtv
mythtv_api_base: http://192.168.0.70:6544
```
## Run server
Make sure `~/.local/bin` is in your $PATH.
```
mythme
```
## Command line options
```
-h, --help show this help message
--version show mythme's version
--host HOST Server host
--port PORT Server port
```
## Channel icons
Channel icons are disabled by default.
To enable, click the dropdown caret next to the Channel column heading.
Check the "Icons" box and confirm.
Raw data
{
"_id": null,
"home_page": null,
"name": "mythme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "mythtv, canned, search",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/82/30/1154fead419bbf9f8005ae85fca094beb50a7f8341ed4da22d2ad98eb817/mythme-0.0.8.tar.gz",
"platform": null,
"description": "# mythme\n**Find and record programs on MythTV**\n\nInspired by [MythWeb](https://github.com/MythTV/mythweb)'s Canned Searches feature, mythme makes it easy\nto create and save custom queries. For example, a query named `Horror Movies of the 1930s`:\n\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/query-dark.png\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/query-light.png\">\n <img alt=\"mythme query\" src=\"https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/query-light.png\">\n</picture>\n\nThe result after clicking Save:\n\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/programs-dark.png\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/programs-light.png\">\n <img alt=\"mythme programs\" src=\"https://raw.githubusercontent.com/donaldoakes/mythme/main/docs/img/programs-light.png\">\n</picture>\n\n\n## Prerequisites\n- python 3\n- mariadb connector/c\n\n## Installation\nThis installs to a local virtual environment.\n```\npython -m venv ~/.local --system-site-packages\n~/.local/bin/pip install mythme\n```\n\n## Environment variable\nThe MYTHME_DIR environment variable points to a directory where mythme\nstores saved queries and other items. It's also where you can create a mythme.yaml\nfile to [configure](#configuration) mythme.\n```\nexport MYTHME_DIR=\"~/.mythme\"\n```\n(default is `~/.mythme`)\n\n## Configuration\nIn many cases no configuration is required. This is especially true if you're\nrunning mythme on MythTV's master backend host.\n### Database\nFor [Database Configuration](https://www.mythtv.org/wiki/Config.xml#Database),\nmythme looks for `~/.mythtv/config.xml` and uses the `<Database>` element if present.\n### MythTV API server\nTo determine the [MythTV Services API](https://www.mythtv.org/wiki/Services_API) host, mythme tries\n`BackendServerAddr` and `BackendStatusPort` from MythTV's `settings` db table.\n### Custom config\nSettings specified in `$MYTHME_DIR/mythme.yaml` override the autoconfig values above.\nHere's an example mythme.yaml:\n```yaml\ndatabase:\n host: '192.168.0.70'\n port: 3306\n database: mythconverg\n username: mythtv\n password: mythtv\n\nmythtv_api_base: http://192.168.0.70:6544\n```\n\n## Run server\nMake sure `~/.local/bin` is in your $PATH.\n```\nmythme\n```\n\n## Command line options\n```\n-h, --help show this help message\n--version show mythme's version\n--host HOST Server host\n--port PORT Server port\n```\n\n## Channel icons\nChannel icons are disabled by default.\nTo enable, click the dropdown caret next to the Channel column heading.\nCheck the \"Icons\" box and confirm.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Donald Oakes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Find and record programs on MythTV",
"version": "0.0.8",
"project_urls": {
"Bug Reports": "https://github.com/donaldoakes/mythme/issues",
"Homepage": "https://github.com/donaldoakes/mythme#readme",
"Source": "https://github.com/donaldoakes/mythme"
},
"split_keywords": [
"mythtv",
" canned",
" search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98c86c3692b1eaf49755b3d728e879a5a73bfab3c241dab7fac7d1934a4d7b3d",
"md5": "97f5fe529d5611bb45d2de943480ab7b",
"sha256": "bf1ba0c29255f13a870a8349fa446f8d05c0f880f74aa67aff6ddaa2a0be029b"
},
"downloads": -1,
"filename": "mythme-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97f5fe529d5611bb45d2de943480ab7b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 386077,
"upload_time": "2024-10-27T00:02:41",
"upload_time_iso_8601": "2024-10-27T00:02:41.649614Z",
"url": "https://files.pythonhosted.org/packages/98/c8/6c3692b1eaf49755b3d728e879a5a73bfab3c241dab7fac7d1934a4d7b3d/mythme-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82301154fead419bbf9f8005ae85fca094beb50a7f8341ed4da22d2ad98eb817",
"md5": "382061a2a102dfa70531d463adab73ed",
"sha256": "7e92660b7e889106f7b3fd98f9e817a342d052fff63af55ef258cc17a191912a"
},
"downloads": -1,
"filename": "mythme-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "382061a2a102dfa70531d463adab73ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 382260,
"upload_time": "2024-10-27T00:02:44",
"upload_time_iso_8601": "2024-10-27T00:02:44.025018Z",
"url": "https://files.pythonhosted.org/packages/82/30/1154fead419bbf9f8005ae85fca094beb50a7f8341ed4da22d2ad98eb817/mythme-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 00:02:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "donaldoakes",
"github_project": "mythme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "mythme"
}
