-
Notifications
You must be signed in to change notification settings - Fork 60
Closed
Labels
area: python clientrelevant to python clientrelevant to python clientdocumentationImprovements or additions to documentationImprovements or additions to documentationtestingtesting neededtesting neededtriageissue to be triageissue to be triage
Description
Welcome, EuroPython sprinters! We are about to release the new Python client that includes the document API. That means lots of testing and documentation. Or if you just wanna play around, feel free :-)
The stuff that we focus here:
terminusdb-client/woqlschema/woql_schema.py
: this is the file that let us build with the document API, think of it as ORMterminusdb-client/scripts/
: here is the scripts that allows using theterminusdb
commend, the library Click is used hereget_document
,get_documents_by_type
,get_all_documents
,insert_document
,replace_document
anddelete_document
interminusdb-client/woqlclient/woqlClient.py
: this are the new API endpoint for the document APIterminusdb-client/woql_type.py
: supporting util for type conversion
Two things that is super welcome 1. Test on any of the above 2. docstring writing.
To set up the environment:
- clone the repo, change to
dev
branch (very important) - set up the dev enviroment with pipenv (details here) Note: we are using Python >= 3.7 for the new dev
- get the dev docker image of TerminusDB (with the bootstrap)
- make sure you set up the
EVN
file withTERMINUSDB_TAG=dev
All work merge to dev
branch please, we have not release this yet
Metadata
Metadata
Assignees
Labels
area: python clientrelevant to python clientrelevant to python clientdocumentationImprovements or additions to documentationImprovements or additions to documentationtestingtesting neededtesting neededtriageissue to be triageissue to be triage