Skip to content

[EuroPython 2021] Work on woql_schema and scripts #220

@Cheukting

Description

@Cheukting

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 ORM
  • terminusdb-client/scripts/ : here is the scripts that allows using the terminusdb commend, the library Click is used here
  • get_document, get_documents_by_type, get_all_documents, insert_document, replace_document and delete_document in terminusdb-client/woqlclient/woqlClient.py : this are the new API endpoint for the document API
  • terminusdb-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:

  1. clone the repo, change to dev branch (very important)
  2. set up the dev enviroment with pipenv (details here) Note: we are using Python >= 3.7 for the new dev
  3. get the dev docker image of TerminusDB (with the bootstrap)
  4. make sure you set up the EVN file with TERMINUSDB_TAG=dev

All work merge to dev branch please, we have not release this yet

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: python clientrelevant to python clientdocumentationImprovements or additions to documentationtestingtesting neededtriageissue to be triage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions