renovation 0.2.0

Drawing tool that produces floor plans needed to renovate an apartment

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
• allows versioning projects with VCSs like Git
• does not require any special MCPs for drawing with AI agents

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:

pip install renovation

To generate floor plans, run:

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 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

You may notice that the first demo config is quite low-level. Everything is set independently. However, the package provides a way to anchor an object to other objects. To get more insights, look at this demo example and an image rendered with it.