Skip to content
A Python library and tools for the Knora-API
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
knora
test
.editorconfig
.gitignore
.travis.yml
BUILD.bazel
LICENSE
MANIFEST.in
Makefile
README.md
WORKSPACE
lists.json
mkdocs.yml
requirements.txt
setup.py

README.md

PyPI version

knora-py

knora-py 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:

  • Knora Python modules for accessing Knora using the API (ontology creation, data import/export etc.)
  • knora-create-ontology A command line program to create an ontology out of a simple JSON description
  • knora-reset-triplestore A command line program to reset the content of the ontology. Does not require a restart of the Knora-Stack.

Go to Full Documentation

Install

To install the latest published version from PyPI, run:

$ pip3 install knora

To upgrade to the latest published version, run:

$ pip3 install --upgrade knora

Local Development Environment

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
$ make dist

You can install the package locally from the dist:

$ python3 -m pip ./dist/some_name.whl

Upload package with twine,

first create ~/.pypirc:

[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_knora
You can’t perform that action at this time.