Skip to content

Commit 7098431

Browse files
committed
add pypi description
1 parent 56a34ca commit 7098431

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/description.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# UmakaParser
2+
3+
This tool is to make a JSON file for [Umaka Viewer](https://umaka-viewer.dbcls.jp/).
4+
5+
First, you need to prepare a metadata file in the [SPARQL Builder Meatadata (SBM)](http://www.sparqlbuilder.org/doc/sbm_2015sep/) format.
6+
If you want to get such a metadata file, [TripleDataProfiler](https://bitbucket.org/yayamamo/tripledataprofiler/src/master/) can generate it for a SPARQL endpoint.
7+
8+
Then, if you have ontology files for the target endpoint or RDF dataset, you need to make asset files by this tool as follows.
9+
10+
`umakaparser --build-index [--dist <Path to put an asset file>] <ontology files in Turtle>`
11+
12+
If you have ontology files only in RDF/XML, this tool converts them into those in Turtle as follows.
13+
14+
`umakaparser --convert <files in RDF/XML>`
15+
16+
Finally, this tool generates a JSON file that can be accepted by [Umaka Viewer](https://umaka-viewer.dbcls.jp/) as follows.
17+
18+
`umakaparser --build [--a <Path to asset files>|--d <Path to put a generated JSON file>] <an SBM file>`
19+
20+
The JSON file structure is [here](https://github.com/dbcls/umakaparser/wiki/Data-specification).

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "umakaparser"
3-
version = "0.1.8"
3+
version = "0.2.2"
44
description = ""
55
authors = ["DBCLS"]
66
license = "MIT"
@@ -14,6 +14,7 @@ classifiers = [
1414
'Programming Language :: Python :: 3.9',
1515
'License :: OSI Approved :: MIT License',
1616
]
17+
readme = "docs/description.md"
1718

1819
[tool.poetry.dependencies]
1920
python = ">=3.7"

0 commit comments

Comments
 (0)