Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 4.49 KB

README.md

File metadata and controls

84 lines (57 loc) · 4.49 KB

Open Raadsinformatie API

Master: Build Status Develop: Build Status

Open Raadsinformatie (ORI) aims to collect and standardize governmental decision making documents of Dutch municipalities (gemeenten, provincies, waterschappen). Open Raadsinformatie is a collaborative effort of the Open State Foundation, Ontola and VNG Realisatie.

Important links

Installation and usage

See this guide to install the Open Raadsinformatie API using Docker, Vagrant or manually. There are also a few usage commands to get you started. Check out the maintenance guide for info on how to manage this project in production.

The docker-compose.yml specifies an external docker_nginx-load-balancer network. For local development use docker network create docker_nginx-load-balancer to create it.

Latest docker version uses "-" as separator when creating container names instead of "_". You can still get the old functionality by adding "--compatibility" to docker compose. So when using the latest Docker in development, use the following to start the containers: docker compose --compatibility -f docker-compose.yml -f docker-compose.dev.yml up --build -d

Testing

The next lines were copied from the Github workflow (which never ran) and still have to be tested:

  • docker compose --compatibility -f docker-compose.yml -f docker-compose.test.yml up --build -d
  • docker exec ori_backend_1 bin/run_tests.sh 2>&1
  • docker exec ori_backend_1 pylint ocd_backend -E -sy

Supported Sources

Data extraction support is available for the following source systems:

How to add your municipality

Get in touch with Sander Bakker from VNG Realisatie. Your griffie (municipality clerk) needs to formally agree that the data becomes open data, and the source system might need some configuration.

Related repositories

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Bugs and feature requests

Have a bug or a feature request? Please first read through and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Authors and contributors

The Open Raadsinformatie API was originally based on the Open Cultuur Data API.

Authors and contributors of both projects are:

Contributors:

Copyright and license

The Open Raadsinformatie project is distributed under the MIT license.