Skip to content

Nikolay-Lysenko/renovation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyPI version

Renovation

Overview

This is a drawing tool that produces floor plans needed to renovate an apartment.

Walls, doors, windows, and dimension arrows are supported. 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. Compared with drag-and-drop tools, config-based interface simplifies fine-grained control.

Let us dive into details. Please look at a demo example as s 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 the generated images are shown below:

floor_plan_with_dimensions.png

floor_plan_without_dimensions.png

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

About

Drawing tool that produces floor plans needed to renovate an apartment.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages