Skip to main content

A generic implementation of the Open Data Protocol for Plone.

Project description

collective.opendata

Introduction

A generic implementation of a pluggable open data package for Plone.

The Plone Open Data API.

The Plone Open Data API.

Features

This package have by default two (02) open data pluggable as the following:

CMS

A plugin for information about the CMS used in this portal.

  • site_info: Information about a portal.

This plugin generate a JSON format from the base API URL: http://localhost:8080/Plone/apidata/cms

[{
    "uri": "http://localhost:8080/Plone/apidata/cms/site_info",
    "description": "Information about a portal",
    "entity": "site_info"
}]

A JSON format for Information site, like this:

{
  "software": "collective.opendata",
  "description": "",
  "software_version": "0.1",
  "title": "Site"
}

Content Metadata

A plugin for content information.

  • News Item: Dublin Core info for News Item.

  • Image: Dublin Core info for Image.

  • File: Dublin Core info for File.

  • Folder: Dublin Core info for Folder.

  • Document: Dublin Core info for Document.

  • Event: Dublin Core info for Event.

This plugin generate a JSON format from the base API URL: http://localhost:8080/Plone/apidata/content

[
  {
    "uri": "http://localhost:8080/Plone/apidata/content/News Item",
    "description": "Dublin Core info for News Item",
    "entity": "News Item"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Image",
    "description": "Dublin Core info for Image",
    "entity": "Image"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/File",
    "description": "Dublin Core info for File",
    "entity": "File"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Folder",
    "description": "Dublin Core info for Folder",
    "entity": "Folder"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Document",
    "description": "Dublin Core info for Document",
    "entity": "Document"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Event",
    "description": "Dublin Core info for Event",
    "entity": "Event"
  }
]

A JSON format for Folder content type, like this:

[
  {
    "title": "News",
    "identifier": "http://localhost:8080/Plone/news",
    "uid": "07997a0ee8f14414bfcf8c146cc865f2",
    "uri": "http://localhost:8080/Plone/apidata/content/Folder/07997a0ee8f14414bfcf8c146cc865f2"
  },
  {
    "title": "Events",
    "identifier": "http://localhost:8080/Plone/events",
    "uid": "bf5aafa2c7224eb5935d174c1a9a43ff",
    "uri": "http://localhost:8080/Plone/apidata/content/Folder/bf5aafa2c7224eb5935d174c1a9a43ff"
  },
  {
    "title": "Users",
    "identifier": "http://localhost:8080/Plone/Members",
    "uid": "761536d101414a47bc0e5494f51d97f1",
    "uri": "http://localhost:8080/Plone/apidata/content/Folder/761536d101414a47bc0e5494f51d97f1"
  }
]

Creation

This product was created by the PloneGov-BR community in a sprint at Interlegis:

http://www.softwarelivre.gov.br/plone

Special thanks to Érico Andrei!

Translations

This product has been translated into

  • Portuguese (thanks, Jean Ferri)

  • Spanish (thanks, Leonardo J. Caballero G.)

Contribute

Support

If you are having issues, please let us know, submit a ticket with the report http://github.com/plonegovbr/collective.opendata/issues

License

The project is licensed under the GNU General Public License v2 (GPLv2).


Mostly Harmless

Travis CI badge Coveralls badge

Contributors

  • Augusto Herrmann

  • Cintia Cinquini

  • Érico Andrei

  • Jean Ferri

  • Héctor Velarde

  • Leonardo Caballero

  • Nitai Bezerra

Changelog

1.0a1 (2015-08-07)

  • Add Portuguese translation. [jeanferri]

  • Fix content type from Page to Document. [jeanferri]

  • Prepare for release on pypi. [jeanferri]

  • Updated README file with usefull information about this package. [macagua]

  • Added Spanish translation. [macagua]

  • Added i18n support. [macagua]

  • Initial release. [ericof]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.opendata-1.0a1.zip (36.3 kB view details)

Uploaded Source

File details

Details for the file collective.opendata-1.0a1.zip.

File metadata

File hashes

Hashes for collective.opendata-1.0a1.zip
Algorithm Hash digest
SHA256 b8fa8bcd2be52c2ebccad516a5e887de36a847da843e245cc6627efb0bf137c2
MD5 5091d92271680e8a063128c06fbd3c55
BLAKE2b-256 7887e07ced33c2da3cd80bd363fd4db1cc84d70a94efe49f64ef786e4d4c3ccb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page