TerminusDB Client Python
Python version of the TerminusDB client - for TerminusDB API and WOQLpy
Requirements
- TerminusDB 2.0.5
- [Python >= 3.6]
Previous Versions
These previous version(s) works with these version(s) of TerminusDB:
- 0.1.5 - works with TerminusDB server / console v2.0.4
Installation
- TerminusDB Client can be download form PyPI using pip:
python -m pip install terminusdb-client
this only include the core Python Client (WOQLClient) and WOQLQuery.
If you want to use woqlDataframe:
python -m pip install terminusdb-client[dataframe]
if you are installing form zsh
you have to quote the argument like this:
python -m pip install 'terminusdb-client[dataframe]'
- Install from source:
python -m pip install git+https://github.com/terminusdb/terminusdb-client-python.git
Usage
For the full Documentation
Tutorials
Visit terminus-tutorials for tutorial scripts and Create TerminusDB Graph with Python Client for a python-specific one.
Testing
-
Clone this repository
git clone https://github.com/terminusdb/terminusdb-client-python.git
-
Install all development dependencies
$ make init
- (a) To run test files only
$ pytest terminusdb_client/tests
- (b) To run full test
$ tox
Documentation
Documentation on the latest version can be found here.
generating documentation locally
-
Clone this repository
git clone https://github.com/terminusdb/terminusdb-client-python.git
-
Install all development dependencies
$ make init
- Change directory to docs
$ cd docs/
- Build with Sphinx
$ make html
The output files are under docs/build/html
, open index.html
in your browser to inspect.
Report Issues
If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
If you encounter other questions, you can ask in our community forum or Discord.
Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
Please check Contributing.md for more information.
Licence
Apache License (Version 2.0)
Copyright (c) 2019