edgedb-python is the official EdgeDB driver for Python. It provides both blocking IO and asyncio implementations.
The library requires Python 3.6 or later.
The project documentation can be found here.
The library is available on PyPI. Use pip
to install it:
$ pip install edgedb
import datetime
import edgedb
def main():
# Establish a connection to an existing database named "test"
# as an "edgedb" user.
conn = edgedb.connect('edgedb://edgedb@localhost/test')
# Create a User object type
conn.execute('''
CREATE TYPE User {
CREATE REQUIRED PROPERTY name -> str;
CREATE PROPERTY dob -> cal::local_date;
}
''')
# Insert a new User object
conn.query('''
INSERT User {
name := <str>$name,
dob := <cal::local_date>$dob
}
''', name='Bob', dob=datetime.date(1984, 3, 1))
# Select User objects.
user_set = conn.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 connection.
conn.close()
if __name__ == '__main__':
main()
Instructions for installing EdgeDB and edgedb-python locally can be found at edgedb.com/docs/internals/dev/.
To run the test suite, run $ python setup.py test
.
edgedb-python is developed and distributed under the Apache 2.0 license.