https://github.com/weso/rdfsync

Wikibase to RDF. An algorithm to synchronize data between the ontology or RDF files and a given Wikibase instance.
https://github.com/weso/rdfsync

ontology wikibase-instance

Last synced: about 2 months ago
JSON representation

Wikibase to RDF. An algorithm to synchronize data between the ontology or RDF files and a given Wikibase instance.

• Host: GitHub
• URL: https://github.com/weso/rdfsync
• Owner: weso
• License: mit
• Created: 2020-09-30T13:16:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-04T15:32:06.000Z (almost 4 years ago)
• Last Synced: 2024-04-14T12:14:18.450Z (9 months ago)
• Topics: ontology, wikibase-instance
• Language: Python
• Homepage: https://www.weso.es/rdfsync/
• Size: 211 KB
• Stars: 4
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rdfsync

[![Build Status](https://travis-ci.com/weso/rdfsync.svg?branch=master)](https://travis-ci.com/github/weso/rdfsync)

[![Coverage Status](https://codecov.io/gh/weso/rdfsync/branch/master/graph/badge.svg)](https://codecov.io/gh/weso/rdfsync)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6df235099f9b4dd5816551e6c82d432a)](https://www.codacy.com/gh/weso/rdfsync/dashboard?utm_source=github.com&utm_medium=referral&utm_content=weso/rdfsync&utm_campaign=Badge_Grade)

[![License](https://img.shields.io/github/license/weso/rdfsync)](https://github.com/weso/rdfsync/blob/master/LICENSE)

[![Version](https://img.shields.io/badge/version-0.1.0-blue)](https://github.com/weso/rdfsync)

An algorithm to synchronise data between the ontology files and a given Wikibase instance.

It updates an ontology file from the changes made in your Wikibase instance.

## Warning Notice

This repository will be read-only and any new changes will be made in the repository [wikibase-sync!](https://github.com/weso/wikibase-sync) destinated to both-way synchronization of ontologies and wikibase instances.

## How to install

You can install it manually from the source code:

```bash

git clone https://github.com/weso/rdfsync

cd rdfsync

python setup.py install

```

Python 3.7+ is required.

## How to synchronize

With the following code you can synchronize the modification of your ontology or rdf file with the updated given

Wikibase instance:

```python

from rdfsync.wb2rdf.conversion import Converter

from rdfsync.githubcon.github_connection import GithubConnection

from rdflib import Graph

import ntpath

# graph ops

file_path = FILE_PATH  # your rdf file path, required even if the file's empty

# algorithm execution

converter = Converter(endpoint=MEDIAWIKI_API_URL, input_format='ttl')  # (http|https)://XXX/w/api.php

converter.read_file_and_create_graph(file_path)  # creates a graph from the rdf file

# items_props_to_sync = {'P228', 'Q1', 'P10'} # if you know the items that changed

items_props_to_sync = converter.get_items_properties_to_sync()

for item_property in items_props_to_sync:

    converter.execute_synchronization(wb_id=item_property)  # synchronization

# if you want to create the file in a specific directory, UNCOMMENT THE FOLLOWING CODE

# final_graph = Graph()

# final_graph.parse(converter.serialize_file(output_format='ttl'))

# final_graph.serialize(FILE_DESTINATION, format='ttl', encoding='utf8')

# pushing the changes to github in a specific branch and pull request

github_token = GITHUB_ACCESS_TOKEN  # personalized github access token

repository_name = GITHUB_TARGET_REPO  # your github repository name

source_branch = SOURCE_BRANCH  # master or main

target_branch = TARGET_BRANCH  # your new branch name in order to create the PR

file_name = ntpath.basename(file_path)

file_content = converter.serialize_file()

gitcon = GithubConnection()

gitcon.update_github_repo(github_token=github_token, repository_name=repository_name, source_branch=source_branch,

                          target_branch=target_branch, file_name=file_name, file_content=file_content)

```