| Name | DiamondFire.py JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | DiamondFire templating library in Python. |
| upload_time | 2024-10-13 20:51:10 |
| maintainer | None |
| docs_url | None |
| author | HellishBro |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 Technical DiamondFire 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 |
diamondfire
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DiamondFire.py
DiamondFire templating library in Python
## Installation
The package can be found on PYPI at [DiamondFire.py](https://pypi.org/project/DiamondFire.py/). To install, open terminal
and type in:
```shell
python3 -m pip --upgrade DiamondFire.py
```
This will install the package.
## Quick Start
The package can be used under the namespace `df`. Here's an example program that generate code that counts to 10:
```python
import df
index_variable = df.Variable(df.VariableScope.LINE, "index")
template = df.Template([
df.CodeBlock(df.CodeBlockCategory.PLAYER_EVENT, "Join"),
df.CodeBlock(df.CodeBlockCategory.REPEAT, "Multiple", [index_variable, 10]),
df.Bracket(open=True, repeat=True),
df.CodeBlock(df.CodeBlockCategory.PLAYER_ACTION, "SendMessage", [index_variable]),
df.Bracket(open=False, repeat=True)
])
print(template.compress())
template.send_to_codeclient()
```
## Features
- Templates
- Code Blocks
- Brackets
- CodeClient API
## Documentation
I'm too lazy to figure out how to generate doc HTML so the docstring is shown by your IDE.
Raw data
{
"_id": null,
"home_page": null,
"name": "DiamondFire.py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "DiamondFire",
"author": "HellishBro",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/33/44/3903a380711494ab2b5286500a7ac583e7ad12438694e22c4168593ff993/diamondfire_py-0.0.3.tar.gz",
"platform": null,
"description": "# DiamondFire.py\r\nDiamondFire templating library in Python\r\n\r\n## Installation\r\nThe package can be found on PYPI at [DiamondFire.py](https://pypi.org/project/DiamondFire.py/). To install, open terminal\r\nand type in:\r\n```shell\r\npython3 -m pip --upgrade DiamondFire.py\r\n```\r\nThis will install the package.\r\n\r\n## Quick Start\r\nThe package can be used under the namespace `df`. Here's an example program that generate code that counts to 10:\r\n```python\r\nimport df\r\n\r\nindex_variable = df.Variable(df.VariableScope.LINE, \"index\")\r\n\r\ntemplate = df.Template([\r\n df.CodeBlock(df.CodeBlockCategory.PLAYER_EVENT, \"Join\"),\r\n df.CodeBlock(df.CodeBlockCategory.REPEAT, \"Multiple\", [index_variable, 10]),\r\n df.Bracket(open=True, repeat=True),\r\n df.CodeBlock(df.CodeBlockCategory.PLAYER_ACTION, \"SendMessage\", [index_variable]),\r\n df.Bracket(open=False, repeat=True)\r\n])\r\n\r\nprint(template.compress())\r\ntemplate.send_to_codeclient()\r\n```\r\n\r\n## Features\r\n- Templates\r\n- Code Blocks\r\n- Brackets\r\n- CodeClient API\r\n\r\n## Documentation\r\nI'm too lazy to figure out how to generate doc HTML so the docstring is shown by your IDE.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Technical DiamondFire 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": "DiamondFire templating library in Python.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/TechnicalDF/DiamondFire.py",
"Issues": "https://github.com/TechnicalDF/DiamondFire.py/issues"
},
"split_keywords": [
"diamondfire"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef374cf6f6108c5a073caad47820a5f14f23a455c1f684410918afabeb1e114b",
"md5": "4cb3e97206111ecc9c537ccb20d1b2eb",
"sha256": "691fcc533dff27fadc7d89bde58b3c5c622e8b874451a6cf007c4194ab6d9b1e"
},
"downloads": -1,
"filename": "DiamondFire.py-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cb3e97206111ecc9c537ccb20d1b2eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 15545,
"upload_time": "2024-10-13T20:51:08",
"upload_time_iso_8601": "2024-10-13T20:51:08.177368Z",
"url": "https://files.pythonhosted.org/packages/ef/37/4cf6f6108c5a073caad47820a5f14f23a455c1f684410918afabeb1e114b/DiamondFire.py-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33443903a380711494ab2b5286500a7ac583e7ad12438694e22c4168593ff993",
"md5": "f0487e1946dfe92bd3cb2f7af5219ba8",
"sha256": "515fcbdc8e35814514cc55d18f3eda5de8bd60ce44f562788b7c1493f39deacb"
},
"downloads": -1,
"filename": "diamondfire_py-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "f0487e1946dfe92bd3cb2f7af5219ba8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 12556,
"upload_time": "2024-10-13T20:51:10",
"upload_time_iso_8601": "2024-10-13T20:51:10.225354Z",
"url": "https://files.pythonhosted.org/packages/33/44/3903a380711494ab2b5286500a7ac583e7ad12438694e22c4168593ff993/diamondfire_py-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-13 20:51:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TechnicalDF",
"github_project": "DiamondFire.py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "diamondfire.py"
}
