8000 GitHub - Lur1an/gel-python: The official Python client library for Gel · GitHub
[go: up one dir, main page]

Skip to content

Lur1an/gel-python

 
 

Repository files navigation

The Python driver for Gel

https://github.com/geldata/gel-python/workflows/Tests/badge.svg?event=push&branch=master https://img.shields.io/badge/join-github%20discussions-green

gel-python is the official Gel driver for Python. It provides both blocking IO and asyncio implementations.

The library requires Python 3.9 or later.

Documentation

The project documentation can be found here.

Installation

The library is available on PyPI. Use pip to install it:

$ pip install gel

Basic Usage

import datetime
import gel

def main():
    client = gel.create_client()
    # Create a User object type
    client.execute('''
        CREATE TYPE User {
            CREATE REQUIRED PROPERTY name -> str;
            CREATE PROPERTY dob -> cal::local_date;
        }
    ''')

    # Insert a new User object
    client.query('''
        INSERT User {
            name := <str>$name,
            dob := <cal::local_date>$dob
        }
    ''', name='Bob', dob=datetime.date(1984, 3, 1))

    # Select User objects.
    user_set = client.query(
        'SELECT User {name, dob} FILTER .name = <str>$name', name='Bob')
    # *user_set* now contains
    # Set{Object{name := 'Bob', dob := datetime.date(1984, 3, 1)}}

    # Close the client.
    client.close()

if __name__ == '__main__':
    main()

Development

Instructions for installing Gel and gel-python locally can be found at docs.geldata.com/resources/guides/contributing/code.

To run the test suite, run $ python setup.py test.

License

gel-python is developed and distributed under the Apache 2.0 license.

About

The official Python client library for Gel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 71.1%
  • Cython 20.6%
  • C 6.0%
  • C++ 1.4%
  • Other 0.9%
0