| Name | renovation JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Drawing tool that produces floor plans needed to renovate an apartment |
| upload_time | 2025-01-03 17:40:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
apartments
drawing
floor_plan
floor_plans
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/renovation/)
# Renovation
## Overview
This is a drawing tool that produces floor plans. It is controlled through YAML config files and has no built-in GUI (only CLI is provided). Although it may look like a drawback, people with technical background may find it more convenient. Compared with drag-and-drop tools, config-based interface simplifies fine-grained control and allows versioning projects with VCSs like Git.
The below figure demonstrates available elements.
Some other elements can be composed of them. For example, in the next section it is shown how to draw ventilation duct and French balcony.
## Usage
To install a stable version, run:
```bash
pip install renovation
```
To generate floor plans, run:
```bash
python -m renovation -c /path/to/config.yml
```
Here, config in YAML is a custom file where properties of each element to be drawn are set. These properties include location, orientation, size, and so on.
Let us dive into details. Please look at a [demo example](https://github.com/Nikolay-Lysenko/renovation/blob/master/docs/demo_configs/simple_floor_plan.yml) as a reference while reading further explanations.
The section named `project` defines properties of output such as:
* Extension (multi-page PDF document, directory with PNG images, or both)
* Location
* DPI (dots-per-inch, resolution)
In the demo config, only PNG output is requested and one of the generated images is shown below:
In the section named `default_layout`, below parameters are set for floor plans that do not override them in their `layout` sections:
* Dimensions of area to be drawn (in real-world meters, i.e., meters prior to scaling)
* Scale
* Grid settings
The section named `reusable_elements` is designed to store arbitrary collections of elements that can be used by individual floor plans. Demo example uses it to define walls, windows, and doors.
Finally, settings of individual floor plans are listed. These settings might include:
* Title
* Layout
* Names of element collections to reuse
* Extra elements
Raw data
{
"_id": null,
"home_page": null,
"name": "renovation",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "apartments, drawing, floor_plan, floor_plans",
"author": null,
"author_email": "Nikolay Lysenko <nikolay-lysenco@yandex.ru>",
"download_url": "https://files.pythonhosted.org/packages/85/2e/226a9e7c7f7453a440c20789db664d166d570f981117b973914805fb8df5/renovation-0.1.1.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/renovation/)\n\n# Renovation\n\n## Overview\n\nThis is a drawing tool that produces floor plans. It is controlled through YAML config files and has no built-in GUI (only CLI is provided). Although it may look like a drawback, people with technical background may find it more convenient. Compared with drag-and-drop tools, config-based interface simplifies fine-grained control and allows versioning projects with VCSs like Git.\n\nThe below figure demonstrates available elements.\n\n\n\nSome other elements can be composed of them. For example, in the next section it is shown how to draw ventilation duct and French balcony.\n\n## Usage\n\nTo install a stable version, run:\n```bash\npip install renovation\n```\n\nTo generate floor plans, run:\n```bash\npython -m renovation -c /path/to/config.yml\n```\nHere, config in YAML is a custom file where properties of each element to be drawn are set. These properties include location, orientation, size, and so on. \n\nLet us dive into details. Please look at a [demo example](https://github.com/Nikolay-Lysenko/renovation/blob/master/docs/demo_configs/simple_floor_plan.yml) as a reference while reading further explanations.\n\nThe section named `project` defines properties of output such as:\n* Extension (multi-page PDF document, directory with PNG images, or both)\n* Location\n* DPI (dots-per-inch, resolution)\n\nIn the demo config, only PNG output is requested and one of the generated images is shown below: \n\n\n\nIn the section named `default_layout`, below parameters are set for floor plans that do not override them in their `layout` sections:\n* Dimensions of area to be drawn (in real-world meters, i.e., meters prior to scaling)\n* Scale\n* Grid settings\n\nThe section named `reusable_elements` is designed to store arbitrary collections of elements that can be used by individual floor plans. Demo example uses it to define walls, windows, and doors.\n\nFinally, settings of individual floor plans are listed. These settings might include:\n* Title\n* Layout\n* Names of element collections to reuse\n* Extra elements\n",
"bugtrack_url": null,
"license": null,
"summary": "Drawing tool that produces floor plans needed to renovate an apartment",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/Nikolay-Lysenko/renovation"
},
"split_keywords": [
"apartments",
" drawing",
" floor_plan",
" floor_plans"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b42ae271871b30adf35c94195be06a52dc608da1d6885ed5574a6d7cda22f9e8",
"md5": "eff40e772a1dd7cff77c9cda3c68691f",
"sha256": "9f76cbd04162b8740bcaa3d15bca52e6c666919b5388c9874900585e6edb5cbe"
},
"downloads": -1,
"filename": "renovation-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eff40e772a1dd7cff77c9cda3c68691f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17276,
"upload_time": "2025-01-03T17:40:44",
"upload_time_iso_8601": "2025-01-03T17:40:44.627314Z",
"url": "https://files.pythonhosted.org/packages/b4/2a/e271871b30adf35c94195be06a52dc608da1d6885ed5574a6d7cda22f9e8/renovation-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "852e226a9e7c7f7453a440c20789db664d166d570f981117b973914805fb8df5",
"md5": "2cfad0f8ace06e515b8cab9c6f8fa5f2",
"sha256": "0fec3c539a9629d3647897130e0d96eec684b7782478cbda0a44b3c9136354eb"
},
"downloads": -1,
"filename": "renovation-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2cfad0f8ace06e515b8cab9c6f8fa5f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13813,
"upload_time": "2025-01-03T17:40:47",
"upload_time_iso_8601": "2025-01-03T17:40:47.183955Z",
"url": "https://files.pythonhosted.org/packages/85/2e/226a9e7c7f7453a440c20789db664d166d570f981117b973914805fb8df5/renovation-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 17:40:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Nikolay-Lysenko",
"github_project": "renovation",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "renovation"
}
