Table of Contents

This section of the OpenSpending documentation is for developers. Here you can learn about the design of the platform, and how to get OpenSpending running locally or on your own servers, and the process for contributing enhancements and bug fixes to the code.

Getting started

Let's get started then! If you want to get the whole OpenSpending platform running locally, or deployed to your own servers, then go straight to the platform section of the documentation. For details on distinct components, go to the appropriate section from the list below.

Platform

OpenSpending as a complete platform is run as a set of Docker containers via Docker Compose. Configurations are available to get running quickly on a local machine, or a remote server for production use.

Datastore

The OpenSpending Datastore is a flat file datastore with source data stored in Fiscal Data Packages.

API

The OpenSpending API offers a rich suite of methods to query the database.

Conductor

A set of integration web services for OpenSpending, responsible for identity, notification, and access control.

Packager

The OpenSpending Packager is a Javascript application to validate source data, model it into a Fiscal Data Package, and publish data to the OpenSpending Datastore.

Viewer

The OpenSpending Viewer is a Javascript application that provides views over data uploaded to OpenSpending.

Explorer

The OpenSpending Explorer is a Javascript application that provides an interface to explore the packages available in the OpenSpending database.

Views

The OpenSpending Views library is a set of JavaScript components for the visualisation of fiscal data.

Auth Client

The OpenSpending Auth Client is a Javascript library for working with the OpenSpending Auth APIs.

CLI

The OpenSpending CLI is a Python lib and command line interface to interact with an OpenSpending instance.

Where Does My Money Go?

Where Does My Money Go? is a simple visualisation of government budget and spend data, using the bubble tree and map components.