https://github.com/nens/ribxlib

A library for the GWSW.ribx exchange format
https://github.com/nens/ribxlib

Last synced: 4 days ago
JSON representation

A library for the GWSW.ribx exchange format

• Host: GitHub
• URL: https://github.com/nens/ribxlib
• Owner: nens
• License: gpl-3.0
• Created: 2015-01-12T13:30:09.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-09-29T10:24:12.000Z (about 7 years ago)
• Last Synced: 2024-04-12T01:12:29.634Z (7 months ago)
• Language: Python
• Size: 4.63 MB
• Stars: 0
• Watchers: 33
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
ribxlib

==========================================

A library for parsing RIBX and RIBXA files, initially for use in the

Upload Server but without unnecessary external dependencies.

Error checking is currently not complete, there is an emphasis on the

fields that are used in the Upload Server (mostly location, ref and

inspection date fields of pipes, manholes and drains).

Checks

------

The RIBX parser can be run in two modes: PREINSPECTION or INSPECTION.

This influences how the RIBX is parsed.

There are two parsers: a TreeParser and an ElementParser. The

ElementParser implements specific checks for the SewerElements, i.e.,

it checks the contents inside of the ``ZB_?`` tags. The ``?`` is

variable and depends on the type of sewerage element that is being

inspected.

The following checks are currently implemented:

- ?AA (mandatory)

- ?BF (inspection date)

- ?BG (inspection time (optional))

- For Pipes ZB_A and ZB_G:

  - ?AD and ?AF must be present (i.e., two manholes)

- ?AB (start location)

- ?AQ (ownership)

- Check for video for specific sewerage elements. If a sewerage element is

  marked as having videos, then the ?BS tag is parsed. In PREINSPECTION mode

  this may be empty, but in INSPECTION mode this must contain one video name.

- ?XD (no work done/work impossible). Also the reason is checked, we have

  the following reasons:

  - 'A': 'Voertuig/obstakel op toegang'

  - 'B': 'Straat niet toegankelijk voor het voertuig'

  - 'C': 'Groen blokkeert de toegang'

  - 'D': 'Niet aangetroffen'

  - 'E': 'Deksel vast'

  - 'Z': 'Andere reden.

  If the reason is 'Z' the '?DE' tag is parsed as the reason.

- ?XC (a new sewerage element that wasn't on the planning)

- ?ZC (observations, must be empty in PREINSPECTION mode)

Local setup

-----------

There's a docker, so do a one-time-only::

  $ docker-compose build

There's no `bootstrap.py` anymore, instead just run::

  $ docker-compose run web buildout

And to run the tests::

  $ docker-compose up

Or alternatively::

  $ docker-compose run web bin/test

Handy debug script

------------------

There's a handy debug script that prints out information on what's been found

in a ribx file::

  $ docker-compose run web bin/ribxdebug some-file.ribx

(Note: the file should be accessible for the command running inside the

docker. ``~/Downloads/some-file.ribx`` won't work :-) )

To adjust the output, you should look at the various ``.print_for_debug()``

methods in ``models.py`` first. The actual main script is in ``script.py``.