Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ General features for object oriented interaction with knowledge graphs are plann
pip install osw
```

### Variants
| Variant | Description |
| -- | -- |
`osw[wikitext]` | Additional functions in `wiki_tools` to transform mediawiki markup / templates
`osw[DB]` | interact with SQL databases per DatabaseController
`osw[S3]` | Interact with S3 Stores per S3FileController
`osw[dataimport]` | Additional tools to import data
`osw[UI]` | To use a helper UI to work with entity slots

To install multiple optional/extra dependencies run
```
pip install osw[opt1, opt2, ...]
```

To install all optional/extra dependencies run
```
pip install osw[all]
```


## Troubleshooting

### `Error: datamodel-codegen not found`
Expand Down
1 change: 1 addition & 0 deletions examples/page_manipulation.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ def mass_page_edit():
wtsite = WtSite.from_domain("wiki-dev.open-semantic-lab.org", pwd_file_path)
# wtpage = wtsite.get_WtPage("LabNote:220601-sist-0001-ni")
# wtpage = wtsite.get_WtPage("testesfesefsef")
# wtpage.parse_main_slot()
# wtpage.append_template("TestTemplate", {"p1": "v1"})
# wtpage.append_text("Some text",)
# wtpage.append_template("TestTemplate", {"p1": "v2"})
Expand Down
26 changes: 20 additions & 6 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ install_requires =
pydantic>=1.10.17
datamodel-code-generator>=0.25
mwclient>=0.10.0
mwparserfromhell
rdflib
PyLD
SPARQLWrapper
Expand All @@ -68,7 +67,7 @@ install_requires =
dask
asyncio
tqdm
pybars3
pybars3-wheel

[options.packages.find]
where = src
Expand All @@ -79,10 +78,24 @@ exclude =
# Add here additional requirements for extra features, to install with:
# `pip install osw[PDF]` like:
# PDF = ReportLab; RXP
dataimport = geopy; deepl
DB = psycopg2; sqlalchemy
UI = pysimplegui
S3 = boto3
wikitext =
mwparserfromhell
DB =
psycopg2
sqlalchemy
S3 =
boto3
dataimport =
geopy
deepl
UI =
pysimplegui
all =
%(dataimport)s
%(DB)s
%(UI)s
%(S3)s
%(wikitext)s

# Add here dev requirements (semicolon/line-separated)
dev =
Expand All @@ -99,6 +112,7 @@ testing =
deepl
sqlalchemy
psycopg2-binary # see: https://www.psycopg.org/docs/install.html#psycopg-vs-psycopg-binary
mwparserfromhell

[options.entry_points]
# Add here console scripts like:
Expand Down
Loading
Loading