Skip to content

Commit

Permalink
add pypi description
Browse files Browse the repository at this point in the history
  • Loading branch information
sasaujp committed Apr 27, 2022
1 parent 56a34ca commit 7098431
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
20 changes: 20 additions & 0 deletions docs/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# UmakaParser

This tool is to make a JSON file for [Umaka Viewer](https://umaka-viewer.dbcls.jp/).
First, you need to prepare a metadata file in the [SPARQL Builder Meatadata (SBM)](http://www.sparqlbuilder.org/doc/sbm_2015sep/) format.
If you want to get such a metadata file, [TripleDataProfiler](https://bitbucket.org/yayamamo/tripledataprofiler/src/master/) can generate it for a SPARQL endpoint.
Then, if you have ontology files for the target endpoint or RDF dataset, you need to make asset files by this tool as follows.
`umakaparser --build-index [--dist <Path to put an asset file>] <ontology files in Turtle>`
If you have ontology files only in RDF/XML, this tool converts them into those in Turtle as follows.
`umakaparser --convert <files in RDF/XML>`
Finally, this tool generates a JSON file that can be accepted by [Umaka Viewer](https://umaka-viewer.dbcls.jp/) as follows.
`umakaparser --build [--a <Path to asset files>|--d <Path to put a generated JSON file>] <an SBM file>`
The JSON file structure is [here](https://github.com/dbcls/umakaparser/wiki/Data-specification).
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "umakaparser"
version = "0.1.8"
version = "0.2.2"
description = ""
authors = ["DBCLS"]
license = "MIT"
Expand All @@ -14,6 +14,7 @@ classifiers = [
'Programming Language :: Python :: 3.9',
'License :: OSI Approved :: MIT License',
]
readme = "docs/description.md"

[tool.poetry.dependencies]
python = ">=3.7"
Expand Down

0 comments on commit 7098431

Please sign in to comment.