Skip to content

andrewlorien/standard

 
 

Repository files navigation

360Giving Logo

360Giving Standard

360Giving aims to help UK grant makers and philanthropists to publish their grant information online in an easy to use way. We are motivated by a commitment to the value of open data and strategic funding.

The 360Giving Data Standard provides a common approach for publishing grant data.

For more about the overall project, visit the main 360Giving website.

Full documentation of the data standard is provided at http://www.threesixtygiving.org/standard

Schema and tools

From Version 1.0 of the schema and onwards:

  • The authoritative source of the standard is found in 360-giving-schema.json and 360-giving-package-schema.json in JSON Schema format (the former describes what a grant should look like, the second describes how to package up multiple grants into a single JSON file).
  • Two secondary serialisation templates are generated using the flatten-tool: a summary table (CSV/XLS), and multi-table template (XLS)
  • A JSON Table Schema is provided for the summary table

This repository stores the latest versions of the schema, along with tools used in generating secondary serialisations and documentation.

Editing documentation

Edit the documentation in the documentation/src directory, and then run sync_schema.sh (described below) to pull information from the schema into the compiled docs in the documentation directory.

Synchronising schemas

After any changes to the schemas, or to the source documentation, sync_schema.sh script should be run to:

  • Generate CSV and XLSX templates
  • Update the documentation

Installation

To use the sync_schema.sh script you will need a virtual environment set up.

git clone https://github.com/ThreeSixtyGiving/standard.git
cd standard
python3 -m virtualenv -p $(which python3) .ve
source .ve/bin/activate
pip install -r requirements.txt

Synchronising schema

With the virtual environment activated (source pyenv/bin/activate) run ./sync_schema.sh

About

The 360Giving data standard for UK philanthropic giving

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 100.0%