A Python library and tools for the DaSCH Service Platform
Project description
DSP-TOOLS - The DaSCH Service Platform Tools Repository
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
Install
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
Local Development Environment
- Python3
- Bazel
Please consult the https://docs.dasch.swiss/developers documentation on how to install these prerequisites.
Makefile for repository management tasks
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
Testing
$ make test
Publishing to PyPi
Generate distribution package. Make sure you have the latest versions of setuptools
and wheel
installed:
$ 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 .
Requirements
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
Running tests with Bazel
Run all tests:
$ bazel test //...
Run single test:
$ bazel test //test:test_user
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file dsp-tools-0.9.13.tar.gz
.
File metadata
- Download URL: dsp-tools-0.9.13.tar.gz
- Upload date:
- Size: 90.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a70ea4660bf0d962e2b4f1ae98eeab95ba8ecd77398880b69ee3664ee478002 |
|
MD5 | 91560e13f7713e97dd35eb71dea7fd3e |
|
BLAKE2b-256 | cb6b8b2eaf4f02f7a457412a97262843ebef2eab8957c361166eddb00b32eb81 |
File details
Details for the file dsp_tools-0.9.13-py3-none-any.whl
.
File metadata
- Download URL: dsp_tools-0.9.13-py3-none-any.whl
- Upload date:
- Size: 181.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 651ebb92ded87fcbc70e4d7b706e08333d5f1d81eba2bbf7a8278b271c19f430 |
|
MD5 | b33750d42a6e9e451ddbb627c5c34389 |
|
BLAKE2b-256 | 9866bdc27738c1bcf37182123a939c903c1087477d86e082ea438acce467ee6c |