Structured data export

[pisipite]

to be able to export the data into different formats.

• csv+frictionless data
• Direkt36 or other special formats

[KrzysztofMadejski]

Acceptance Criteria (may be a bit more loose):

• [x] REST API for structured data
• [x] xslx
• [x] custom object manager that will filter objects not fully transcribed
• [x] Documentation how to set up export and where it would be available Lower priority:
• [x] frictionless data output
• [x] interface for custom exporter
• [x] Guidelines on how to write your own exporter
• [x] registering models / configuring exporter fields
• [x] export as a terminal command

[KrzysztofMadejski]

To implement REST API there are some libraries mentioned here: https://github.com/humiaozuzu/awesome-flask

[KrzysztofMadejski]

Ideally models should be registered with moonsheep and everything else should work out of the box.

from django.db import models
from moonsheep import register

@register.model(api=True, export_exclude_fields=[])
class Declaration(models.Model):
     ...

Effect:

• JSON-API compliant API generated at http://your.domain/api/declaration
• Excel export outputting a spreadsheet containing as many sheets as there are models defined

All @register.model parameters should be optional.

[KrzysztofMadejski]

@catileptic I'm working on it now.

[KrzysztofMadejski]

Implementing an API for domain model is as simple as:

from moonsheep.api import AppApi
urlpatterns = [
    # url(r'^admin/', admin.site.urls),
    # url(r'^moonsheep/', include('moonsheep.urls')),
    # ...

    url(r'^api/opora/', include(AppApi('opora').urls)),
]

AppApi scans for all domain models defined in your app (passed in the param) and generates URL for each using Django Rest Framework. Rest Framework gives you a nice html interface to play with requests, discovery (listing of all endpoints). Using moonsheep-opora example: http://localhost:8000/api/opora/