Extension GitHub Metadata Import


Extension Basics

Title
GitHub Metadata Import
Name
ckanext-gitimport
Type
Public extension
Description
The CKAN GitImport Plugin enables users to fetch and display GitHub repository metadata within a specialized 'GitHub' template in the CKAN user interface. After the metadata is displayed, it can be stored within CKAN datasets. Features include: automatic fetching of GitHub repository metadata via 'Fetch Metadata' button, dynamic population of CKAN dataset fields with GitHub data (contributors, topics, etc.), seamless integration with CKAN's UI. The plugin works with the 'GitHub' template created using ckanext-scheming extension. Requires a GitHub access token for API access.
CKAN versions

~2.10,~2.11

Show details
Download-Url (zip)
Last commit
2 years ago (2024-02-28 13:26:10)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-gitimport

The CKAN GitImport Plugin enables users to fetch and display GitHub repository metadata within a specialized “GitHub” template in the CKAN user interface. After the metadata is displayed, it can be stored within CKAN datasets. This plugin streamlines the process of linking GitHub repositories with CKAN datasets, making it more efficient and user-friendly.

Features

  • Fetch GitHub Repository Metadata: Automatically retrieves metadata from GitHub repositories by simply adding the repository name then pressing the “Fetch Metadata” button.
  • Dynamic Field Population: Dynamically populates CKAN dataset fields with fetched GitHub metadata, such as contributors, topics, etc., as needed.
  • User-Friendly Interface: Seamlessly integrates with CKAN’s UI.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.10 yes
2.9 and earlier not tested

Installation

To install ckanext-gitimport:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/Mazen-B/ckanext-gitimport.git cd ckanext-gitimport pip install -e . pip install -r requirements.txt

  3. Add gitImport to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config settings

The plugin requires a GitHub access token to fetch repository data. Please ensure that the token is valid as they usually expire after a certain time. You will need to regenerate a new token periodically to maintain functionality.

Add your GitHub access token to the CKAN config file:

ckanext.gitimport.github_access_token = YOUR_GITHUB_ACCESS_TOKEN

Usage

To use the plu

Version
(not set)
Version release date
(not set)
Contact name
Mazen-B
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-gitimport:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/Mazen-B/ckanext-gitimport.git cd ckanext-gitimport pip install -e . pip install -r requirements.txt

  3. Add gitImport to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN. F

Plugins to configure (ckan.ini)
streamlines gitimport
CKAN Settings (ckan.ini)
# ckanext.gitimport.github_access_token = YOUR_GITHUB_ACCESS_TOKEN
DB migration to be executed
(not set)
<< back to Extensions