dsp-tools is a python package containing a command line tool for data model (ontology) creation, a library allowing creation of single resources and mass upload using the bulk import of data into the Knora framework.
The package consists of:
dsplib
Python modules for accessing Knora using the API (ontology creation, data import/export etc.)dsp-tools
A command line program to perfrom several operations on a DSP server:- create an ontology out of a simple JSON description
- dump an existing ontology from a DSP server to a JSON file
- Bulk-upload of data from a XML data file
Go to Full Documentation
Please note that dsp-tools require Python 3.9 for working properly!
To install the latest published version from PyPI, run:
$ pip3 install dsp-tools
To upgrade to the latest published version, run:
$ pip3 install --upgrade dsp-tools
- Python3
- Bazel
Please consult the https://docs.dasch.swiss/developers documentation on how to install these prerequisites.
The project contains a Makefile defining management tasks. Please use
make help
to see what is available.
To install from source, i.e., this repository, run:
$ make install
$ make test
Generate distribution package. Make sure you have the latest versions of setuptools
and wheel
installed.
Remove the dist
and buil
-directories: rm -rf bild dist
$ make upgrade-dist-tools
$ make dist
You can install the package locally from the dist:
$ python3 -m pip install ./dist/some_name.whl
Upload package with twine
,
first create ~/.pypirc
in your home folder:
[distutils]
index-servers=pypi
[pypi]
repository = https://upload.pypi.org/legacy/
username =your_username_on_pypi
then upload:
$ make upload
For local development:
$ python3 setup.py --editable .
To install the requirements:
$ pip3 install -r requirements.txt
To generate a "requirements" file (usually requirements.txt), that you commit with your project, do:
$ pip3 freeze > requirements.txt
Run all tests:
$ bazel test //...
Run single test:
$ bazel test //test:test_user