Spinta documentation!

Spinta is a tool for managing open and not necessarily open data. It consists of these main components:

command line tool:

A command line tool spinta, for managing data and metadata.

data publishing server:

An HTTP server, with an API for publishing data.

These tools work together using same metadata describing data. Metadata is compatible with DCAT standard, but extended to support describing data at individual column level.

Metadata format is a simple table consisting of 5 dimension and 10 metadata columns.

You can open data following these simple steps:

1. Describe your dataset.

   You can automatically inspect you data source using this command:

   spinta inspect sqlite:////data.db -o manifest.xlsx
   

   Then you need to open manifest.xlsx using your favorite spreadsheed program and fill in missing metadata, specified which columns you want to open.

   While describing your data you can preview how things would look, before publishing anything:

   spinta run --mode external manifest.xlsx
   

   This will read data directly from the data source (--mode external) and will run a local data publishing server.

2. Publish your dataset.

   When you have your dataset fully described, you can publish you data into a data publishing server (assuming you have one up and running):

   spinta push manifest.xlsx -o https://client@data.example.com
   

   For this command to work, you need to add client credentials to ~/.config/spinta/credentials.cfg file.

Opening and publishing your data has never been so simple!

Manual

• Configuration
  • More on configuration
  • Inspecting configuration
  • Configuring spinta
  • Configuration directory
• Access control
  • Client registration
  • Default client
  • Scopes
  • Access token
  • Access levels
  • Client credentials
• Manifest
  • Functions
• Functions
• Migrations
  • Creating new model
  • Running migrations
  • Changing existing model
• Logging
  • Configuring logging
  • Log message format
  • Reading log messages

Reference

• Components
  • Configuration
  • Request
  • Store
  • Manifest
• Commands
  • Startup process
  • Request handling

Contributing

• Contributing
  • Development environment
  • Writing tests
  • Functions
  • Manifests

Indices and tables

• Index
• Module Index
• Search Page