AptScan

Apartment Floor Plan Scanner

AptScan swiftly scans floor plans, automating chair type counting for each room in the floor plan. It provides the user with the number of chairs in each room and the total number of chairs in the floor plan.

Installation

To install, follow these steps:

1. Create a Python virtual environment using your preferred choice (pyenv is recommended)

2. With the recently created virtual environment activated, install the package with the following command:

   make setup

Note: aptscan requires Python 3.10 or newer.

Usage

To display the help message with the available commands and options, run:

aptscan --help

To scan a floor plan, use the aptscan console utility. Ex.:

aptscan rooms.txt

Running tests

1. Run tests with:

   make test

2. And check code coverage with:

   make coverage
   open htmlcov/index.html

Extra

1. To see all available make targets:

   make list

License

Code in this repository is distributed under the terms of the BSD 3-Clause License (BSD-3-Clause).

See LICENSE for details.