| Name | masterpiece-xmlformat JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | XML serialization format for the `masterpiece` framework |
| upload_time | 2024-12-08 07:18:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License =========== Copyright (c) 2024, Juha Meskanen 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 |
| keywords |
object-oriented
plugin
framework
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
XML Serialization Format
========================
This project implements the `masterpiece_xmlformat` Python package to add XML support to `masterpiece`
applications.
Usage
-----
To install:
.. code-block:: bash
pip install masterpiece_xmlformat
Once installed, you can pass the `--init` and `--application_serialization_format`
startup arguments to create a default set of configuration files. For example, to create
XML configuration files for the 'examples/myapp.py' application:
.. code-block:: bash
mkdir -p ~/.myhome/config
python examples/myhome.py --init --application_serialization_format XMLFormat
Upon successful execution, there should be a file located at `~/.myhome/config/MyHome.xml`
with the following content:
.. code-block:: xml
<?xml version='1.0' encoding='utf-8'?>
<MyHome>
<solar>0.0</solar>
<color>yellow</color>
</MyHome>
To use XML as the default format, add the following line of code to your application:
.. code-block:: python
Application.serialization_format = "XMLFormat"
License
-------
This project is licensed under the MIT License - see the `LICENSE` file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "masterpiece-xmlformat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"J. Meskanen\" <juham.api@gmail.com>",
"keywords": "object-oriented, plugin, framework",
"author": null,
"author_email": "J Meskanen <juham.api@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/f5/10a230bbcb728a3485d0453d8dbbd038320c4b2a31e8da04dcd326c7cafc/masterpiece_xmlformat-1.0.2.tar.gz",
"platform": null,
"description": "XML Serialization Format\r\n========================\r\n\r\nThis project implements the `masterpiece_xmlformat` Python package to add XML support to `masterpiece` \r\napplications.\r\n\r\nUsage\r\n-----\r\n\r\nTo install:\r\n\r\n.. code-block:: bash\r\n \r\n pip install masterpiece_xmlformat\r\n\r\nOnce installed, you can pass the `--init` and `--application_serialization_format` \r\nstartup arguments to create a default set of configuration files. For example, to create \r\nXML configuration files for the 'examples/myapp.py' application:\r\n\r\n.. code-block:: bash\r\n\r\n mkdir -p ~/.myhome/config\r\n python examples/myhome.py --init --application_serialization_format XMLFormat\r\n\r\nUpon successful execution, there should be a file located at `~/.myhome/config/MyHome.xml` \r\nwith the following content:\r\n\r\n.. code-block:: xml\r\n\r\n <?xml version='1.0' encoding='utf-8'?>\r\n <MyHome>\r\n <solar>0.0</solar>\r\n <color>yellow</color>\r\n </MyHome>\r\n\r\nTo use XML as the default format, add the following line of code to your application:\r\n\r\n.. code-block:: python\r\n\r\n Application.serialization_format = \"XMLFormat\"\r\n\r\nLicense\r\n-------\r\n\r\nThis project is licensed under the MIT License - see the `LICENSE` file for details.\r\n",
"bugtrack_url": null,
"license": "MIT License =========== Copyright (c) 2024, Juha Meskanen 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 ",
"summary": "XML serialization format for the `masterpiece` framework",
"version": "1.0.2",
"project_urls": {
"Bug Reports": "https://gitlab.com/juham/masterpiece",
"Homepage": "https://gitlab.com/juham/masterpiece_xmlformat",
"Say Thanks!": "http://meskanen.com",
"Source": "https://gitlab.com/juham/masterpiece_xmlformat"
},
"split_keywords": [
"object-oriented",
" plugin",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4936c867a4ea47be81e41937f771cc88cf7b76311ef5341f9da9a9b85b186a8",
"md5": "fd9b485834ec436dffcb0de97765b130",
"sha256": "37484bb6466f2cd23bdc20279f81c539e4aad32b742c32cd1ced456b45875b95"
},
"downloads": -1,
"filename": "masterpiece_xmlformat-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd9b485834ec436dffcb0de97765b130",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5346,
"upload_time": "2024-12-08T07:18:43",
"upload_time_iso_8601": "2024-12-08T07:18:43.586288Z",
"url": "https://files.pythonhosted.org/packages/e4/93/6c867a4ea47be81e41937f771cc88cf7b76311ef5341f9da9a9b85b186a8/masterpiece_xmlformat-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01f510a230bbcb728a3485d0453d8dbbd038320c4b2a31e8da04dcd326c7cafc",
"md5": "ca01766ab6b5c924955419ccdb2fa027",
"sha256": "a433aa68c29df84bfeb321c97af4ee70db0632044cbb62b6385f8191da3ae447"
},
"downloads": -1,
"filename": "masterpiece_xmlformat-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "ca01766ab6b5c924955419ccdb2fa027",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7670,
"upload_time": "2024-12-08T07:18:45",
"upload_time_iso_8601": "2024-12-08T07:18:45.711753Z",
"url": "https://files.pythonhosted.org/packages/01/f5/10a230bbcb728a3485d0453d8dbbd038320c4b2a31e8da04dcd326c7cafc/masterpiece_xmlformat-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 07:18:45",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "juham",
"gitlab_project": "masterpiece",
"lcname": "masterpiece-xmlformat"
}
