Skip to content

Commit b0292fb

Browse files
committedJun 9, 2022
fixing pypi actions and updating README
1 parent f4360e8 commit b0292fb

File tree

2 files changed

+30
-15
lines changed

2 files changed

+30
-15
lines changed
 

‎README.md

+29-15
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
11
# LinkML Schema Automator
22

3-
This is a toolkit that assists with:
3+
This is a toolkit that assists with the generation and enhancement of [LinkML](https://linkml.io/linkml) schemas
44

5-
1. Bootstrapping LinkML models from instance data
6-
- TSVs and spreadsheets
7-
- SQLite databases
8-
- RDF instance graphs
9-
2. Bootstrapping a LinkML model from a different schema representation (i.e. opposite of a linkml.generator)
10-
- OWL (RDFS-like subset)
11-
- TODO: JSON-Schema, XSD, ShEx, SHACL, SQL DDL, FHIR, Python dataclasses/pydantic, etc
12-
3. Using automated methods to enhance a model
13-
- Using text mining and concept annotator APIs to enrich semantic enums
14-
- TODO: querying sparql endpoints to retrieve additional metadata
5+
## Install
156

16-
These can be composed together. For example, run `tsvs2linkml` followed by `annotate-enums`
7+
```bash
8+
pip install schema-automator
9+
```
1710

18-
The toolkit is still experimental. It is intended as an aid to schema creation rather than as a formal conversion
19-
tool.
11+
## Command Line
2012

21-
[Full Documentation](https://linkml.io/schema-automator/)
13+
See [CLI docs](https://linkml.io/schema-automator/cli)
14+
15+
Generalizing:
16+
17+
```bash
18+
schemauto generalize-tsv my-data.tsv > my-schema.yaml
19+
```
20+
21+
Importing:
22+
23+
```bash
24+
schemauto import-json-schema their.schema.json > my-schema.yaml
25+
```
26+
27+
Annotating:
28+
29+
```bash
30+
schemauto annotate-schema my-schema.yaml
31+
```
32+
33+
## Full Documentation
34+
35+
[linkml.io/schema-automator](https://linkml.io/schema-automator/)

‎pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ version = "0.0.0"
44
description = "Infer models, enrich with meaning for terms including enum permissible values"
55
authors = ["Chris Mungall", "Mark Miller", "Sierra Moxon", "Harshad Hegde"]
66
license = "BSD 3-Clause"
7+
readme = "README.md"
78

89
packages = [
910
{ include = "schema_automator" }

0 commit comments

Comments
 (0)
Please sign in to comment.