def test__expand_graph_for_pylode():
m = MakeDocco()
m.G.parse(data=o1, format="turtle")
assert len(
m.G
) == 7, "Error loading ontology before expansion. Should have 7 triples, got {}".format(
len(g))
# should add a single rdfs:label for the single dcterms:title
# and a rdf:Property for the owl:ObjectProperty
m._expand_graph_for_owl()
assert len(
m.G
) == 9, "Error loading ontology after expansion. Should have 9 triples, got {}".format(
len(g))
from pylode import MakeDocco
from os.path import join, dirname, abspath
TESTS_DIR = dirname(abspath(__file__))
h = MakeDocco(input_data_file=join(TESTS_DIR, "test_skos_cif.ttl"),
profile='skos')
# generate the HTML doc
h.document(destination=join(TESTS_DIR, "test_skos_cif.html"))
from pylode import MakeDocco from os.path import join, dirname, abspath TESTS_DIR = dirname(abspath(__file__)) h = MakeDocco(input_data_file=join(TESTS_DIR, "test_ont_html_description.ttl")) # generate the HTML doc h.document(destination="test_ont_html_description.html")
def main(args=None):
# read the input ontology file into a graph
parser = argparse.ArgumentParser()
overarching_group = parser.add_mutually_exclusive_group()
inputs_group = overarching_group.add_mutually_exclusive_group()
inputs_group.add_argument(
"-i",
"--inputfile",
help="The RDF ontology file you wish to generate HTML for. "
"Must be in either Turtle, RDF/XML, JSON-LD or N-Triples formats indicated by the file type extensions:"
"{} respectively.".format(", ".join(RDF_FILE_EXTENSIONS)),
type=lambda x: is_valid_file(parser, x),
)
inputs_group.add_argument(
"-u",
"--url",
help="The RDF ontology you wish to generate HTML for, online. "
"Must be an absolute URL that can be resolved to RDF, preferably via Content Negotiation.",
)
overarching_group.add_argument(
"-lp",
"--listprofiles",
help="This flag, if used, must be the only flag supplied. It will cause the program to list all the ontology"
" documentation profiles that it supports, indicating both their URI and their short token for use with the"
" -p (--profile) flag when creating HTML documentation",
action="store_true",
)
parser.add_argument(
"-p",
"--profile",
help="A profile - a specified information model - for an ontology. You can indicate this via the profile's URI"
"or its token. The list of profiles - URIs and their corresponding tokens - supported by pyLODE, can be "
"found by running the program with the flag -lp or --listprofiles.",
default="ontdoc",
)
parser.add_argument(
"-c",
"--css",
help="Whether (true) or not (false) to include CSS within an output HTML file.",
choices=["true", "false"],
default="true",
)
parser.add_argument(
"-q",
"--getcuriesonline",
help="Whether (true) or not (false) to look up CURIEs for unknown namespaces using http://prefix.cc.",
choices=["true", "false"],
default="false",
)
parser.add_argument(
"-o",
"--outputfile",
help="A name you wish to assign to the output file. Will be postfixed with .html/.md if not already added. If "
"no output file is given, output will be printed to screen",
default=None
)
parser.add_argument(
"-f",
"--outputformat",
help="The output format of the documentation.",
choices=["html", "md"],
default="html",
)
parser.add_argument(
"-v",
"--version",
help="The version of this copy of pyLODE.",
action="store_true"
)
args = parser.parse_args()
if args.listprofiles:
print(MakeDocco.list_profiles())
exit()
elif args.version:
from pylode import __version__
print(__version__)
exit()
elif args.inputfile or args.url:
if args.css == "true":
include_css = True
else:
include_css = False
# args are present so getting RDF from input file or uri into an rdflib Graph
if args.inputfile:
h = MakeDocco(
input_data_file=args.inputfile,
outputformat=args.outputformat,
profile=args.profile,
include_css=include_css
)
elif args.url:
h = MakeDocco(
input_uri=args.url,
outputformat=args.outputformat,
profile=args.profile,
include_css=include_css
)
else:
# we have neither an input file or a URI supplied
parser.error(
"Either an input file or a url is required to access the ontology's RDF"
)
if args.profile:
if not MakeDocco.is_supported_profile(args.profile):
parser.error("The profile you requested, '{}', is not supported. "
"Please choose from those given by List Profiles (-lp)".format(args.profile))
else:
parser.error("An ontology source (-i/--inputfile or -u/--url) is required")
# here we have a parsed graph from either a local file or a URI
# name the output file
if args.outputfile is not None:
output_file_name = args.outputfile
if args.outputformat == "html":
if not output_file_name.endswith(".html"):
output_file_name += ".html"
elif args.outputformat == "md":
if not output_file_name.endswith(".md"):
output_file_name += ".md"
# generate the HTML doc
h.document(destination=output_file_name)
print("Finished. {} documentation in {}".format(args.profile, output_file_name))
else:
print(h.document())