https://github.com/nens/bro-exchange

Python package for exchanging data with the BRO
https://github.com/nens/bro-exchange

basisregistratieondergrond

Last synced: 4 days ago
JSON representation

Python package for exchanging data with the BRO

• Host: GitHub
• URL: https://github.com/nens/bro-exchange
• Owner: nens
• License: mit
• Created: 2022-01-25T14:59:52.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-09T13:55:46.000Z (4 months ago)
• Last Synced: 2024-07-09T17:41:39.031Z (4 months ago)
• Topics: basisregistratieondergrond
• Language: Python
• Homepage: https://basisregistratieondergrond.nl/
• Size: 567 KB
• Stars: 2
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.MD

Awesome Lists containing this project

README

        
# bro-exchange

This package contains tools for retrieving data from or sending data to the

Dutch National Key Registry of the Subsurface (Basis Registratie Ondergrond).

The following components:

- Groundwatermonitoringwell (GMW)

- Groundwatermonitoringnetwork (GMN)

- Groundwaterleveldossier (GLD)

- Formationresistancedossier (FRD)

## Installation

 `pip install git+https://github.com/nens/bro-exchange#egg=bro-exchange`

## Usage

**TODO** The usage instructions are still a work in progress. Stay tuned for updates!

## `bro_exchange/`

This module contains the following components working with the 

inname- en uitgifteservice:

- Request and sourcedocument generators: These tools allow you to create

  registration object oriented requests in XML from JSON input.

- Requests handlers: These handlers can be used for validating requests and sending

  them to the innamewebservice.

- Handlers for downloading data from the uitgifteservice. These tools are

  still in development at the moment.

## `examples/`

Notebooks for demonstrating how to generate and send registration object

oriented requests are included in examples\innamewebservice

## Development

Local dev installation:

    $ pip3 install ruff

	$ python3 -m venv .

	$ bin/pip install -e .

Syntax checks:

	$ ruff check .

	$ ruff check . --fix

Formatting ("black"):

	$ ruff format .