Skip to main content

Official Python Standard Library for Xkye Language

Project description

Introducing Xkye-Python standard library to provide objective query builder for xkye language. You can easily query the entities from the xkye file using this library. It provides a more convenient and idiomatic way to write and manipulate queries.


Installation

Install library with pypi:

$ pip3 install xkye

Usage

from xkye import IO as io

#initiate the xkye with io
x = io(filename.xky)

#read the contents of the file
x.read()

#get the output of any of the entity from teh xky file
#to get the value of the entity
x.get("entityname")

#to get the value of the entity in the given clutch
x.get("entityname","clutchname")

#to get the value of the entity in the given cluth's span
x.get("entityname","clutchname", clutchspan)

#to get the span count of the given cluster
x.getSpan("clustername")

Examples

Please use the examples directory to see some complex examples using xkye-pyhton library. For details about xkye syntax and format, use the offical Xkye-lang documentation.


Documentation

Documentation is available at xkye-python.readthedocs.io .


Version matrix

Xkye version

Xkye-Python Library version

>= 1.0.0

>= 1.0.0


Upcoming features on or before v2.0.0

  • Ability to get the span limit of the given cluster (Completed)

  • Ability to add entity, clutch and subclutch


Contribution Guide

Want to hack on Xkye-Python? Awesome! We have Contribution-Guide on our official repo. If you are not familiar with making a pull request using GitHub and/or git, please read this guide . If you’re looking for ways to contribute, please look at our issue tracker .


License

Xkye-python is open-source standard python library for xkye language that is released under the MIT License. For details on the license, see the LICENSE file.


If you like this library, help me to develop it by buying a cup of coffee

Buy Me A Coffee Badge

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xkye-1.0.1.tar.gz (16.4 kB view hashes)

Uploaded Source

Built Distribution

xkye-1.0.1-py3-none-any.whl (20.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page