Metadata-Version: 2.4
Name: woningwaardering
Version: 4.3.1
Summary: Berekent de punten van een woning op basis van het woningwaarderingsstelsel.
Author-email: Woonstad Rotterdam <info@woonstadrotterdam.nl>, Ben Verhees <ben.verhees@woonstadrotterdam.nl>, Tiddo Loos <tiddo.loos@woonstadrotterdam.nl>, Tomer Gabay <tomer.gabay@woonstadrotterdam.nl>
Project-URL: Homepage, https://github.com/woonstadrotterdam/woningwaardering
Project-URL: Issues, https://github.com/woonstadrotterdam/woningwaardering/issues
Keywords: woning,waardering,stelsel,woningwaarderingsstelsel,wws
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic>=2.10
Requires-Dist: loguru>=0.7
Requires-Dist: PyYAML>=6.0
Requires-Dist: prettytable>=3.17.0
Requires-Dist: pandas>=2.2
Requires-Dist: requests>=2.31
Requires-Dist: types-pyyaml>=6.0
Provides-Extra: test
Requires-Dist: pre-commit>=3.3; extra == "test"
Requires-Dist: ruff>=0.5; extra == "test"
Requires-Dist: pytest>=8.3; extra == "test"
Requires-Dist: pytest-cov>=5.0; extra == "test"
Requires-Dist: types-requests>=2.32; extra == "test"
Requires-Dist: types-python-dateutil>=2.9; extra == "test"
Provides-Extra: dev
Requires-Dist: aiohttp>=3.11; extra == "dev"
Requires-Dist: woningwaardering[test]; extra == "dev"
Requires-Dist: woningwaardering[monumenten]; extra == "dev"
Requires-Dist: datamodel-code-generator[http]>=0.25.6; extra == "dev"
Requires-Dist: unidecode>=1.3; extra == "dev"
Requires-Dist: jinja2>=3.1; extra == "dev"
Requires-Dist: libcst==1.4; extra == "dev"
Requires-Dist: requests>=2.31; extra == "dev"
Requires-Dist: inquirer>=3.4; extra == "dev"
Requires-Dist: tomli>=2.2; extra == "dev"
Provides-Extra: monumenten
Requires-Dist: monumenten>=2.0.1; extra == "monumenten"
Dynamic: license-file

![](https://img.shields.io/pypi/pyversions/woningwaardering)
![Build Status](https://github.com/woonstadrotterdam/woningwaardering/actions/workflows/cicd.yml/badge.svg)
[![Version](https://img.shields.io/pypi/v/woningwaardering)](https://pypi.org/project/woningwaardering/)
![](https://img.shields.io/github/license/woonstadrotterdam/woningwaardering)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

# Woningwaardering

Ga voor uitgebreide documentatie over de **woningwaardering** package naar [Read The Docs](https://woningwaardering.readthedocs.io/stable/).

<!--tip-start-->

> [!TIP]
> Deze versie kan gebruikt worden voor het berekenen van de woningwaardering volgens het woningwaarderingsstelsel voor zelfstandige woonruimten volgens [het beleidsboek van de huurcommissie van januari 2026 (Wet Betaalbare Huur)](https://www.huurcommissie.nl/huurcommissie-helpt/beleidsboeken_html). Aan de berekeningen en output van deze package kunnen geen rechten worden ontleend. Raadpleeg de [documentatie](https://woningwaardering.readthedocs.io/stable/), [de toelichting op de implementatie van het beleidsboek](https://woningwaardering.readthedocs.io/stable/implementatietoelichtingen/) en [de openstaande issues](https://github.com/woonstadrotterdam/woningwaardering/issues) aandachtig om de package op een constructieve manier te gebruiken en de resultaten correct te interpreteren.

<!--tip-end-->

## Doel

<!--overzicht-start-->

Het Microservices team van Woonstad Rotterdam is in Q1 2024 begonnen met het ontwikkelen met een open-source Python-package waarmee het mogelijk wordt om het puntensysteem van het [woningwaarderingsstelsel](https://aedes.nl/huurbeleid-en-betaalbaarheid/woningwaarderingsstelsel-wws) toe te passen. We gaan hierbij uit van de [VERA-standaard](https://www.coraveraonline.nl/index.php/VERA-standaard) [referentiedata v4.3.260116](https://github.com/Aedes-datastandaarden/vera-referentiedata) & [openapi v4.1.5](https://github.com/Aedes-datastandaarden/vera-openapi) van de corporatiesector voor de in- en output van de package. De reden van het maken van deze package is het volgende:

De package maakt het mogelijk om de woningwaardering te berekenen op basis van een digitale representatie van een woning. Steeds meer woningcorporaties en bedrijven digitaliseren hun woningbestand, vaak met behulp van een bouwwerkinformatiemodel (BIM). Met behulp van deze package worden bulkberekeningen van woningwaarderingen mogelijk. Bovendien kan de woningwaardering door deze package als API te gebruiken in een webapplicatie worden geïntegreerd. Onze berekening biedt een completere en inzichtelijkere berekening van het woningwaarderingsstelsel dan de momenteel beschikbare tools, zoals die van de [huurcommissie](https://www.huurcommissie.nl/huurders/sociale-huurwoning/maximale-huurprijs-berekenen). Omdat onze package volledig open-source is zijn alle geïmplementeerde regels transparent en traceerbaar. Het helpt ook woningcorporaties en bedrijven te voldoen aan de wetgeving zoals de [Wet Betaalbare Huur](https://www.volkshuisvestingnederland.nl/onderwerpen/wet-betaalbare-huur).

> [!NOTE]
> Voor vragen kunt u contact opnemen met Team Microservices via [Tomer Gabay](mailto:tomer.gabay@woonstadrotterdam.nl), [Tiddo Loos](mailto:tiddo.loos@woonstadrotterdam.nl) of [Ben Verhees](mailto:ben.verhees@woonstadrotterdam.nl).

---

![werking-package](https://raw.githubusercontent.com/woonstadrotterdam/woningwaardering/main/docs/afbeeldingen/diagram.png)
_Voorbeeld van hoe wij de woningwaardering package gebruiken bij Woonstad Rotterdam_.

---

![voorbeeld-output](https://raw.githubusercontent.com/woonstadrotterdam/woningwaardering/main/docs/afbeeldingen/voorbeeld_output.jpg)
_Visueel voorbeeld van de output van de package voor een zelfstandige woonruimte._

<!--overzicht-end-->

Voor meer details over wat er precies is geïmplementeerd van het beleidsboek van januari 2026 verwijzen wij naar de [documentatie](https://woningwaardering.readthedocs.io/stable/implementatietoelichtingen/) over de implementatie van dit beleidsboek.

Voor meer informatie over hoe de documentatie van het beleidsboek is gemaakt, verwijzen wij naar het hoofdstuk [Implementatie beleidsboek huurcommissie](https://woningwaardering.readthedocs.io/stable/introductie/opzet/#implementatie-beleidsboek-huurcommissie).

# Opzet woningwaardering package

Voor de opzet van de Woningwaarderingpackage verwijzen we graag naar de [documentatie](https://woningwaardering.readthedocs.io/stable/introductie/opzet/). Hier zal onder andere worden ingegaan op de implemenatie van de Beleidsboeken van de huurcommissie en de repository structuur worden besproken.

<!--installatie-start-->

# Installatie

Gebruikers kunnen de woningwaardering package installaren met

```bash
pip install woningwaardering
```

Vervolgens kun je de package importeren en gebruiken op verschillende manieren.

De woningwaardering package kan op basis van data van het Kadaster en Cultureel Erfgoed de monumentale status van een woning bepalen. Deze functionaliteit is optioneel en kan worden geïnstalleerd met

```bash
pip install woningwaardering[monumenten]
```

<!--installatie-end-->

# Gebruik

Ga voor voorbeelden van het gebruik van de woningwaardering package naar de [documentatie](https://woningwaardering.readthedocs.io/stable/aan-de-slag/#gebruik).
