No project description provided
Project description
Description
The entityrdfizer
project is designed to convert entities of any domain and their data and metadata into RDF.
It requires the entities and their data to be provided as inputs in an ABox CSV template, that is
filled in with data. A group of ABox CSV template files are provided under the following URL:
https://github.com/cambridge-cares/TheWorldAvatar/tree/master/JPS_Ontology/KBTemplates/ABox
Installation
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Virtual environment setup
It is highly recommended to use a virtual environment for the entityrdfizer
installation. The virtual environment can be created as follows:
(Windows)
$ python -m venv entityrdfizer_venv
$ entityrdfizer_venv\Scripts\activate.bat
(entityrdfizer_venv) $
(Linux)
$ python3 -m venv entityrdfizer_venv
$ source entityrdfizer_venv\bin\activate
(entityrdfizer_venv) $
The above commands will create and activate the virtual environment entityrdfizer_venv
in the current directory.
Installation via pip
To install the entityrdfizer
simply run the following command:
(entityrdfizer_venv) $ pip install entityrdfizer
Installation from the version-controlled source (for developers)
This type of installation is only for the developers. To install entityrdfizer
directly from its repository you need to first clone the TheWorldAvatar
project. Then simply navigate to the TheWorldAvatar\EntityRDFizer directory and execute the following commands:
# build and install
(entityrdfizer_venv) $ pip install .
# or build for in-place development
(entityrdfizer_venv) $ pip install -e .
Alternatively, use the provided install_rdfizer.sh
convenience script, that can create virtual environment and install the entityrdfizer
in one go:
# create the environment and install the project
$ install_rdfizer.sh -v -i
# create the environment and install the project for in-place development
$ install_rdfizer.sh -v -i -e
Note that installing the project for in-place development (setting the -e
flag) also installs the required python packages for development and testing. To test the code, simply run the following commands:
(entityrdfizer_venv) $ pytest
# or
(entityrdfizer_venv) $ pytest tests
How to use
Usage:
csv2rdf <csvFileOrDirPath> --csvType=<type> [--outDir=<dir>]
Options:
--csvType=<type> Type of the csv file.
Choose between abox/tbox [default: abox]
--outDir=<dir> Output directory path
Authors
Feroz Farazi (msff2@cam.ac.uk), 17 May 2021
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
Built Distribution
Hashes for entityrdfizer-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67dac73c7f8ec5fd41b359b8603e5675cf82669809f9385a29641052a60e7aa2 |
|
MD5 | 2e58d6de1c0c7088e85e2ac797fd9099 |
|
BLAKE2b-256 | 43d4755348aa5403de3657f76cd3d5dce49eab1db3de6b08237f799a5f8cb55d |