Skip to main content

Drawing tool that produces floor plans needed to renovate an apartment

Project description

PyPI version

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.

individual_elements.png

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:

floor_plan_with_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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

renovation-0.1.1.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

renovation-0.1.1-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file renovation-0.1.1.tar.gz.

File metadata

  • Download URL: renovation-0.1.1.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for renovation-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0fec3c539a9629d3647897130e0d96eec684b7782478cbda0a44b3c9136354eb
MD5 2cfad0f8ace06e515b8cab9c6f8fa5f2
BLAKE2b-256 852e226a9e7c7f7453a440c20789db664d166d570f981117b973914805fb8df5

See more details on using hashes here.

File details

Details for the file renovation-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: renovation-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for renovation-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f76cbd04162b8740bcaa3d15bca52e6c666919b5388c9874900585e6edb5cbe
MD5 eff40e772a1dd7cff77c9cda3c68691f
BLAKE2b-256 b42ae271871b30adf35c94195be06a52dc608da1d6885ed5574a6d7cda22f9e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page