| Name | heishamon-rules-minify JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | A Python CLI to minify Heishamon rules |
| upload_time | 2024-02-12 07:47:28 |
| maintainer | Klaas Hoekstra |
| docs_url | None |
| author | Klaas Hoekstra |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 Klaas Hoekstra 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 |
package
setuptools
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# HeishaMon Rules Minify
> A Python CLI to minify Heishamon rules
[HeishaMon](https://github.com/Egyras/HeishaMon) is a project to read out a Panasonic air-water heat pump using an ESP8266 board. The HeishaMon firmware also supports the use of rules, to control the heatpump from within the HeishaMon itself. Since the ruleset must be stored within HeishaMon, its size must be limited. Therefore, it is best to use short function and variable names in order to maximize the number of rules that can be stored. Moreover, the rules library does not support comments in a ruleset, making it hard to read and maintain a ruleset, but also making it hard to share the ruleset with other.
This project aims to overcome these issues by making it possible write a ruleset with comments and descriptive function and variables names, and then minifying it. This way it is still possible to maximize the number of rules on the HeishaMon.
_Note: The minifier should work for both the rule library used in version 3.2.3 and [this updated rule libaray version](https://github.com/IgorYbema/HeishaMon/pull/121). In the rule library from version 3.2.3, the elseif statement cannot be used_
## Installation
```sh
python3 -m pip install heishamon_rules_minify
```
## Usage example
Start by creating a ruleset that adheres to the HeishaMon rules syntax, but can use the following extras:
- Single line comments starting with `--` or block comments between `--[[` and `]]`.
- Custom function and variable names will be minified to only keep the capital letters, so for example `#WaterTemperature` will become `#WT`.
When the ruleset is finished, minify it using the following command:
```sh
heishamon-rules-minify [input_file] [output_file]
```
This will shorten all custom function and variable names and remove all unneeded spaces and newlines.
## Release History
* 0.0.1
* Initial version
## Contributing
1. Fork it (<https://github.com/yourname/yourproject/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
Raw data
{
"_id": null,
"home_page": "",
"name": "heishamon-rules-minify",
"maintainer": "Klaas Hoekstra",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "klaas.hoekstra94@gmail.com",
"keywords": "package,setuptools",
"author": "Klaas Hoekstra",
"author_email": "klaas.hoekstra94@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2a/e1/6be3f367fa839a8523d39b46c931a4e94e1c6f33831a889b7bec999baf44/heishamon_rules_minify-0.0.2.tar.gz",
"platform": null,
"description": "# HeishaMon Rules Minify\n> A Python CLI to minify Heishamon rules\n\n[HeishaMon](https://github.com/Egyras/HeishaMon) is a project to read out a Panasonic air-water heat pump using an ESP8266 board. The HeishaMon firmware also supports the use of rules, to control the heatpump from within the HeishaMon itself. Since the ruleset must be stored within HeishaMon, its size must be limited. Therefore, it is best to use short function and variable names in order to maximize the number of rules that can be stored. Moreover, the rules library does not support comments in a ruleset, making it hard to read and maintain a ruleset, but also making it hard to share the ruleset with other. \n\nThis project aims to overcome these issues by making it possible write a ruleset with comments and descriptive function and variables names, and then minifying it. This way it is still possible to maximize the number of rules on the HeishaMon.\n\n_Note: The minifier should work for both the rule library used in version 3.2.3 and [this updated rule libaray version](https://github.com/IgorYbema/HeishaMon/pull/121). In the rule library from version 3.2.3, the elseif statement cannot be used_\n\n## Installation\n\n```sh\npython3 -m pip install heishamon_rules_minify\n```\n\n## Usage example\n\nStart by creating a ruleset that adheres to the HeishaMon rules syntax, but can use the following extras:\n\n- Single line comments starting with `--` or block comments between `--[[` and `]]`.\n- Custom function and variable names will be minified to only keep the capital letters, so for example `#WaterTemperature` will become `#WT`.\n\nWhen the ruleset is finished, minify it using the following command:\n\n```sh\nheishamon-rules-minify [input_file] [output_file]\n```\n\nThis will shorten all custom function and variable names and remove all unneeded spaces and newlines.\n\n## Release History\n\n* 0.0.1\n * Initial version\n\n## Contributing\n\n1. Fork it (<https://github.com/yourname/yourproject/fork>)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Klaas Hoekstra 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": "A Python CLI to minify Heishamon rules",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/klaashoekstra94/heishamon-rules-minify",
"documentation": "https://github.com/denkiwakame/heishamon-rules-minify",
"repository": "https://github.com/denkiwakame/heishamon-rules-minify"
},
"split_keywords": [
"package",
"setuptools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ac0b1e3ab59745031e078f851e71939d1db34c6031978155b41aee3305d95c5",
"md5": "658f10efb826e0ea6298bed45cc065c6",
"sha256": "da31d18fca707af6dfe5b28f31b504bb131e0de9e66688c4a3092202bc12b6de"
},
"downloads": -1,
"filename": "heishamon_rules_minify-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "658f10efb826e0ea6298bed45cc065c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6819,
"upload_time": "2024-02-12T07:47:27",
"upload_time_iso_8601": "2024-02-12T07:47:27.270493Z",
"url": "https://files.pythonhosted.org/packages/2a/c0/b1e3ab59745031e078f851e71939d1db34c6031978155b41aee3305d95c5/heishamon_rules_minify-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ae16be3f367fa839a8523d39b46c931a4e94e1c6f33831a889b7bec999baf44",
"md5": "8b2dae41e40bc08f61d56840b57c63b9",
"sha256": "9884e668713cd749288f5951d1efb6477ab432997f066c5ec7eca56211866939"
},
"downloads": -1,
"filename": "heishamon_rules_minify-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "8b2dae41e40bc08f61d56840b57c63b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10193,
"upload_time": "2024-02-12T07:47:28",
"upload_time_iso_8601": "2024-02-12T07:47:28.756959Z",
"url": "https://files.pythonhosted.org/packages/2a/e1/6be3f367fa839a8523d39b46c931a4e94e1c6f33831a889b7bec999baf44/heishamon_rules_minify-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-12 07:47:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klaashoekstra94",
"github_project": "heishamon-rules-minify",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "heishamon-rules-minify"
}
