Skip to content

MI-FraunhoferIWM/data2rdf

Repository files navigation

data2rdf

A pipeline for generating data representation in RDF out of raw data given in ASCII, CSV or EXCEL format.

https://data2rdf.readthedocs.io/en/latest/

Installation

Install for using the package

Either install the package from the pypi

pip install data2rdf

Install for development

Install the package from the source code:

git clone git@github.com:MI-FraunhoferIWM/data2rdf.git
cd data2rdf
pip install -e .

Windows specific

In windows it might be necessary to install curses manually. This can be done with:

pip install windows-curses

Debug a Chowlk XML File

In some cases when the syntax of the draw.io file is not correct (e.g.: missing label on arrow, bracket in class file) chowlk crashes. The only (pretty annoying but working) way to find the wrong syntax is to execute chowlk with the command line for that file and inclemently remove elements from the draw.io diagram. This way you can find the wrong syntax by process of elimination.

Version Updates

  • Chowlk is installed via pip through the dependencies
  • Running csv and excel pipeline
  • Abox pipeline CLI
  • Unnittest for csv and excel pipeline and abox pipeline

Building the docs locally

HTML

A server will start, generate the docs and listen for changes in the source files. This can be done by using docker or installing the development environment directly on the you machine. Next are installation guides for Docker and Linux OS.

Docker

First, build the Docker image by running the following command:

$ docker build -f docs.Dockerfile -t data2rdf-docs .

Then, start the program by running:

$ docker run -it --rm -v $PWD:/app -p 8000:8000 data2rdf-docs

Linux

At an OS level (these commands work on Linux Debian):

$ sudo apt install pandoc graphviz default-jre
$ sudo apt-get install texlive-latex-recommended \
                       texlive-latex-extra \
                       texlive-fonts-recommended \
                       latexmk

The python dependencies:

$ pip install .[docs]

Now you can start the server and render the docs:

$ sphinx-autobuild docs/source docs/build/html

The documentation will be available on http://127.0.0.1:8000.

PDF (LaTeX)

To generate a PDF of the documentation, simply run (from the root project folder):

make -C docs latexpdf

The generated PDF can be found under docs/build/latex/data2rdf_docs.pdf