viktor-platform/bro

A python package that is able to communicate with the REST API of the BRO (BasisRegistratie Ondergrond).

BRO

This package can access the REST API from the BRO. Currently, this package provides functionality to request CPTs from the BRO when you provide a region of interest. The format is based on the REST API of the BRO, which is described here for CPTs.

Current options include retrieval of the following objects:

1. CPTs (format: bytes, dict)

The package also allows export of the retrieved data in GeoJSON format.

Note 1: The BRO is only available for the Netherlands, other locations are not supported.

Note 2: The API of the BRO is limited and requesting large amounts of data may result in instability.

Installation

pip install bro

Use

Example usage to retrieve CPTs from the BRO as dictionaries.

from datetime import datetime

import Envelope
import Point
import get_cpt_characteristics_and_return_cpt_objects

begin_date = datetime(2015, 1, 1).strftime("%Y-%m-%d")
end_date = datetime(2023, 3, 3).strftime("%Y-%m-%d")

# Define small square area that returns 5 valid cpts
lower_corner = Point(51.92269686635185, 4.469594207611851)
upper_corner = Point(51.923034432171065, 4.470094707426648)

area = Envelope(lower_corner, upper_corner)
cpts = get_cpt_characteristics_and_return_cpt_objects(begin_date, end_date, area, as_dict= True)

LICENSE

MIT License

Copyright (c) 2023 VIKTOR

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Publish

• update changelog with version number
• update bro/__version__.py
• tag with version number

bro's Issues

add retrieval of cpt + parsing functionalities

pyproj dependency installation error on Windows

When installing BRO it fails because of a deprecated dependency.

This only seems to be a problem on windows and not on linux.

the dependencies should be updated, I would suggest adding a dependabot checker to this repo to keep the dependencies up-to-date. implementing #23 should solve this also quite a bit.

change date input type str

currently the input if begin_date and end_date is str, while it's easier to just used a datetime or date object from datetime and let the package handle the str formatting.

Update requests dependency

@regbers-viktor @MSlootwegVIKTOR @GliderGeek

Please update request and also implement #23. Versions of Requests between v2.3.0 and v2.30.0 are vulnerable to potential
forwarding of Proxy-Authorization headers to destination servers whenfollowing HTTPS redirects. : https://github.com/psf/requests/releases/tag/v2.31.0

fix fetching of cpts through api

xml structure seems to have been slightly changed

improve geojson properties + styling

fix amount of documents check

reroll changes in xml scheme

test all supported python versions in ci

setup-python should be able to extract that from pyproject.toml: https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#using-the-python-version-file-input

remove deprecated setup.py and replace with toml

fix fetching of cpt characteristics due to change in xml

fix setup.py character length of url

add new action on set times

setup dependabot for pip and github acitons

increase timeout to 20 seconds

In line 280 of api.py, increasing timeout from 10 to 20 fixes a lot of timeouts in an app that uses this package

add url with example app

be less strict with dependencies in requirements

• give range of possible package installations

bug: fix CPTCharacteristics if research report date is unavailable

• add checks for multiple attributes in CPTCharacteristics
• add check if there is a rejection reason in the request + raise error

improve readme / pypi page

currently the page is very empty and ideally describes the package better