Metadata-Version: 2.1
Name: edgedb
Version: 0.7.0a1
Summary: EdgeDB Python driver
Home-page: https://github.com/edgedb/edgedb-python
Author: MagicStack Inc
Author-email: hello@magic.io
License: Apache License, Version 2.0
Description: The Python driver for EdgeDB
        ============================
        
        .. image:: https://travis-ci.com/edgedb/edgedb-python.svg?branch=master
            :target: https://travis-ci.com/edgedb/edgedb-python
        
        .. image:: https://img.shields.io/pypi/v/edgedb.svg
            :target: https://pypi.python.org/pypi/edgedb
        
        
        **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.
        
        
        Documentation
        -------------
        
        The project documentation can be found
        `here <https://edgedb.com/docs/clients/00_python/index>`_.
        
        
        Installation
        ------------
        
        The library is available on PyPI.  Use ``pip`` to install it::
        
            $ pip install edgedb
        
        
        Basic Usage
        -----------
        
        .. code-block:: python
        
            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 -> local_date;
                    }
                ''')
        
                # Insert a new User object
                conn.fetchall('''
                    INSERT User {
                        name := <str>$name,
                        dob := <local_date>$dob
                    }
                ''', name='Bob', dob=datetime.date(1984, 3, 1))
        
                # Select User objects.
                user_set = conn.fetchall(
                    '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()
        
        Development
        -----------
        
        Instructions for installing EdgeDB and edgedb-python locally can be found at
        `edgedb.com/docs/internals/dev/ <https://edgedb.com/docs/internals/dev/>`_.
        
        To run the test suite, run ``$ python setup.py test``.
        
        License
        -------
        
        edgedb-python is developed and distributed under the Apache 2.0 license.
        
Platform: macOS
Platform: POSIX
Platform: Windows
Provides: edgedb
Provides-Extra: docs
Provides-Extra: test
Provides-Extra: dev
