Skip to content

Latest commit

 

History

History
131 lines (90 loc) · 5.34 KB

README.EN.rst

File metadata and controls

131 lines (90 loc) · 5.34 KB
Raw

Public documents registration

Version: 1.0.0-rc.0
Source:https://github.com/GPP-Woo/GPP-publicatiebank
Keywords:WOO, Public Documents, NL, Open Data

Documentation Status Docker image

A registration providing the functionalities for a "public documents" storage.

(Nederlandse versie)

Developed by Maykin B.V. for ICATT and Dimpact.

Introduction

In the Netherlands, legislation require governments to act from the principles of Openness (Wet Open Overheid (Dutch)). Government organizations are required - by law - to actively publish documents produced for the Public sphere, making them accessible to interested parties/citizens. Dimpact provides a Generic Publication Platform to facilitate this for municipalities, of which the Public Documents Registration component is one part.

This registration component makes it possible to draft, manage and publish publications. It exposes the publications, attached documents and supporting resource belonging to publications, such as:

  • organisations (municipalities, working groups)
  • reference value lists (file formats, information categories, themes...)
  • publications and associated documents
  • metadata models and expected shapes of metadata

The component interfaces with a search index (TODO) and ensures the metadata and content of documents is indexed, enabling the citizen portal to search through the publications. The data is provided in a format making it suitable to be indexed by the national crawler, by complying with the Woo-Metadata-standard (Dutch).

API specification

OpenAPI specification checks

Version Release date API specification
latest n/a ReDoc, Swagger, (verschillen)
1.0.0 2024-12-12 ReDoc, Swagger

See: All versions and changes

Developers

Build status Coverage Code style Docker image Supported Python version

This repository contains the source code for the registration component. To quickly get started, we recommend using the Docker image. You can also build the project from the source code. For this, please look at INSTALL.rst.

Quickstart

  1. Download and run woo-publications:

    wget https://raw.githubusercontent.com/GPP-Woo/GPP-publicatiebank/main/docker-compose.yml
docker-compose up -d --no-build

  2. In the browser, navigate to http://localhost:8000/ to access the admin and the API. You can log in with the admin / admin credentials.

References

License

Copyright © Maykin 2024

Licensed under the EUPL