{"id":13506052,"url":"https://github.com/conwetlab/FIWARE-CKAN-Extensions","last_synced_at":"2025-03-30T03:30:33.594Z","repository":{"id":137795990,"uuid":"112608323","full_name":"conwetlab/FIWARE-CKAN-Extensions","owner":"conwetlab","description":"This repository includes the documentation and links to the different CKAN extensions developed within FIWARE","archived":false,"fork":false,"pushed_at":"2020-02-24T09:09:05.000Z","size":5013,"stargazers_count":8,"open_issues_count":8,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-01T04:35:03.108Z","etag":null,"topics":["fiware"],"latest_commit_sha":null,"homepage":null,"language":"API Blueprint","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/conwetlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-30T12:22:50.000Z","updated_at":"2021-10-12T08:36:24.000Z","dependencies_parsed_at":"2023-05-22T14:15:28.577Z","dependency_job_id":null,"html_url":"https://github.com/conwetlab/FIWARE-CKAN-Extensions","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conwetlab%2FFIWARE-CKAN-Extensions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conwetlab%2FFIWARE-CKAN-Extensions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conwetlab%2FFIWARE-CKAN-Extensions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conwetlab%2FFIWARE-CKAN-Extensions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conwetlab","download_url":"https://codeload.github.com/conwetlab/FIWARE-CKAN-Extensions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273533,"owners_count":20750904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fiware"],"created_at":"2024-08-01T01:00:33.799Z","updated_at":"2025-03-30T03:30:33.587Z","avatar_url":"https://github.com/conwetlab.png","language":"API Blueprint","funding_links":[],"categories":["FIWARE Catalogue"],"sub_categories":["Context Data Publication and Monetization"],"readme":"# FIWARE CKAN Extensions\n\n[![](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/data-publication.svg)](https://www.fiware.org/developers/catalogue/)\n[![License badge](https://img.shields.io/github/license/conwetlab/FIWARE-CKAN-Extensions.svg)](https://opensource.org/licenses/AGPL-3.0)\n[![Docker](https://img.shields.io/docker/pulls/fiware/ckan-extended.svg)](https://hub.docker.com/r/fiware/ckan-extended/)\n[![](https://img.shields.io/badge/tag-fiware-orange.svg?logo=stackoverflow)](http://stackoverflow.com/questions/tagged/fiware)\n[![Support](https://img.shields.io/badge/support-askbot-yellowgreen.svg)](https://ask.fiware.org)\n\u003cbr\u003e\n[![Documentation badge](https://img.shields.io/readthedocs/fiware-ckan-extensions.svg)](https://fiware-ckan-extensions.rtfd.io)\n![Status](https://nexus.lab.fiware.org/static/badges/statuses/ckan.svg)\n\nA set of CKAN extensions, developed within FIWARE, which integrates the CKAN\ndata portal platform with the main FIWARE GEs, enhancing the default CKAN\nbehaviour with improved access control, publication of right-time context data,\nand rich visualization features.\n\nThe roadmap of this FIWARE GE is described [here](https://github.com/conwetlab/FIWARE-CKAN-Extensions/blob/master/roadmap.md)\n\nThis project is part of [FIWARE](https://www.fiware.org/). For more information\ncheck the FIWARE Catalogue entry for\n[Data Publication and Monetization](https://github.com/Fiware/catalogue/tree/master/data-publication).\n\n | :books: [Documentation](https://fiware-ckan-extensions.rtfd.io/) |  :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/data-publication/ckan) |  :whale: [Docker Hub](https://hub.docker.com/r/fiware/ckan-extended/) |\n|---|---|---|\n\n## Contents\n\n-   [Background](#background)\n    -   [Description](#description)\n-   [Install](#install)\n-   [Usage](#usage)\n-   [API](#api)\n-   [Advanced Topics](#advanced-topics)\n-   [Quality Assurance](#quality-assurance)\n-   [License](#license)\n\n## Background\n\nThis is the main repository of the FIWARE CKAN extensions. This project is part\nof [FIWARE](https://www.fiware.org).\n\nThe FIWARE CKAN extensions project is not a single repository, but it is\ncomposed of a set projects, each of them implementing a different CKAN\nextension, that together with with [CKAN](https://ckan.org/) made up the\n[FIWARE Extended CKAN portal](https://catalogue.fiware.org/enablers/ckan).\n\nIn particular, the following extensions have been created:\n\n-   **[OAuth2](https://github.com/conwetlab/ckanext-oauth2)**: This extension\n    allows to use an external OAuth2 identity manager (Including but not limited\n    to the FIWARE Idm) to authenticate CKAN users, including both, login in the\n    web portal and accessing the APIs using OAuth2 access tokens.\n-   **[Private Datasets](https://github.com/conwetlab/ckanext-privatedatasets)**:\n    This extension extends the default dataset access permissions by including\n    an access list where it is possible to specify what users can access to the\n    data, even if they are not part of the owner organization\n-   **[Right Time Context](https://github.com/conwetlab/ckanext-right_time_context)**:\n    This extension enables the publication of right-time queries to the\n    [Context Broker](https://catalogue.fiware.org/enablers/publishsubscribe-context-broker-orion-context-broker)\n    as dataset resources.\n-   **[BAE Publisher](https://github.com/FIWARE-TMForum/ckanext-baepublisher)**:\n    This extension integrates CKAN with the FIWARE\n    [Business API Ecosystem](https://catalogue.fiware.org/enablers/business-api-ecosystem-biz-ecosystem-ri),\n    enabling the automatic creation of products and offerings using the\n    information of a private dataset.\n-   **[WireCloud View](https://github.com/conwetlab/ckanext-wirecloud_view)**:\n    This extension allows the creation of rich visualizations for dataset\n    resources by embedding\n    [WireCloud](https://catalogue.fiware.org/enablers/application-mashup-wirecloud)\n    dashboards as resource views.\n-   **[Data Requests](https://github.com/conwetlab/ckanext-datarequests)**: This\n    extension enables users to ask for datasets which are not published in the\n    portal, so it can include not only data offers but data demands.\n\n### Description\n\n[CKAN](https://ckan.org/) is an open data publication platform, widely extended,\nwhich enable the publication, search, discovery and consumption of open\ndatasets.\n\nIn this context, the FIWARE CKAN extensions enhance the default CKAN features in\norder to integrate this tool within the FIWARE ecosystem, supporting the\npublication, management and rich visualization of right-time context data, while\nimproving the access control and enabling data monetization.\n\n## Install\n\nThe detailed instructions on how to install the FIWARE CKAN Extensions can be\nfound at the\n[Installation Guide](http://fiware-ckan-extensions.readthedocs.io/en/latest/installation-administration-guide.html).\n\nIn general, CKAN extensions can be installed using python, following the next\nsteps:\n\n-   Download the plugin from the repository and access it:\n\n```console\n$ git clone https://github.com/\u003cplugin_repo\u003e\n$ cd \u003cplugin_repo\u003e\n```\n\n-   Activate CKAN virtual environment\n\n```console\n$ . /usr/lib/ckan/default/bin/activate\n```\n\n-   Install the extension\n\n```console\n$ python setup.py install\n```\n\n\u003e **Note**: If you want to install the plugin for development, you can use the\n\u003e following command:\n\u003e\n\u003e ```console\n\u003e $ python setup.py develop\n\u003e ```\n\n## Usage\n\nThe different extensions provide an API that can be used in order to manage its\nfeatures programmatically without using the web portal. In particular:\n\n-   Private Datasets:\n    -   **acquisitions_list**: Lists all the private datasets a particular user\n        has been granted access to\n    -   **package_acquired**: Includes a particular user in the list of\n        authorized users of a set of datasets\n    -   **revoke_access**: Removes a particular user from the list of authorized\n        users of a set of datasets\n-   Data Requests:\n    -   **create_datarequest**: Creates a new data request\n    -   **show_datarequest**: Retrieves the information of a data request\n    -   **update_datarequest**: Updates a data request\n    -   **list_datarequests**: Lists the existing data requests\n    -   **delete_datarequest**: Deletes a data request\n    -   **close_datarequest**: Closes a data request\n    -   **comment_datarequest**: Creates a comment in a data request\n    -   **show_datarequest_comment**: Shows the comments of a data request\n    -   **list_datarequest_comments**: Lists the comments of a data request\n    -   **update_datarequest_comment**: Updates a comment of a data request\n    -   **delete_datarequest_comment**: Deletes a comment from a data request\n    -   **follow_datarequest**: Starts following a data request\n    -   **unfollow_datarequest**: Stops following a data request\n\n## API\n\nFor further documentation, you can check the API Reference available at:\n\n-   [Apiary](https://fiwareckanextensions.docs.apiary.io/#)\n\n## Advanced Topics\n\n-   [User \u0026 Programmers Guide](doc/user-programmer-guide.rst)\n-   [Installation \u0026 Administration Guide](doc/installation-administration-guide.rst)\n\nYou can also find this documentation on\n[ReadTheDocs](http://fiware-ckan-extensions.readthedocs.io/)\n\n## Quality Assurance\n\nThis project is part of [FIWARE](https://fiware.org/) and has been rated as\nfollows:\n\n-   **Version Tested:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Version\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.version\u0026colorB=blue)\n-   **Documentation:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Completeness\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.docCompleteness\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Usability\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.docSoundness\u0026colorB=blue)\n-   **Responsiveness:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Time%20to%20Respond\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.timeToCharge\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Time%20to%20Fix\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.timeToFix\u0026colorB=blue)\n-   **FIWARE Testing:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Tests%20Passed\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.failureRate\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Scalability\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.scalability\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Performance\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.performance\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Stability\u0026url=https://fiware.github.io/catalogue/json/ckan.json\u0026query=$.stability\u0026colorB=blue)\n\n---\n\n## License\n\nExtensions to CKAN is licensed under [Affero General Public License (GPL)\nversion 3](./LICENSE).\n\n### Are there any legal issues with AGPL 3.0? Is it safe for me to use?\n\nThere is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL \n(or AGPL) licenses are mostly related with the fact that different people assign different \ninterpretations on the meaning of the term “derivate work” used in these licenses. Due to this,\nsome people believe that there is a risk in just _using_ software under GPL or AGPL licenses\n(even without _modifying_ it).\n\nFor the avoidance of doubt, the owners of this software licensed under an AGPL 3.0 license  \nwish to make a clarifying public statement as follows:\n\n\u003e Please note that software derived as a result of modifying the source code of this\n\u003e software in order to fix a bug or incorporate enhancements is considered a derivative \n\u003e work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise \n\u003e unmodified version of existing software is not considered a derivative work, and therefore\n\u003e it does not need to be released as under the same license, or even released as open source.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconwetlab%2FFIWARE-CKAN-Extensions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconwetlab%2FFIWARE-CKAN-Extensions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconwetlab%2FFIWARE-CKAN-Extensions/lists"}