Metadata-Version: 2.1
Name: frankfurt
Version: 0.1b20
Summary: Frankfurt is an ORM based on asyncpg.
Home-page: https://github.com/jorgeecardona/frankfurt
Author: Jorge E. Cardona
Author-email: jorgeecardona@gmail.com
License: UNKNOWN
Description: 
        =============
        Frankfurt ORM
        =============
        
        .. image:: https://readthedocs.org/projects/frankfurt/badge/?version=latest
           :target: http://frankfurt.readthedocs.io/en/latest/
        .. image:: https://travis-ci.com/jorgeecardona/frankfurt.svg?branch=master
           :target: https://travis-ci.com/jorgeecardona/frankfurt
        .. image:: https://codecov.io/gh/jorgeecardona/frankfurt/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/jorgeecardona/frankfurt
        
        .. inclusion-marker-do-not-remove
        
        ``Frankfurt`` is an Object-Relational Mapping (ORM) library, built on top of asyncpg. It takes ideas from Django, SQLAlchemy and tortoise-orm.
        
        Source and issue tracker are available at https://github.com/jorgeecardona/frankfurt/
        
        Support Python >= 3.7.
        
        
        Introduction
        ------------
        
        Frankfurt is an ORM built on top of asyncpg, henceo, it supports only PostgreSQL.
        
        I am taking ideas from Django, SQLAlchemy and tortoise-orm to built this.
        
        Installation
        ------------
        
        The recommended way to install ``frankfurt`` is via pip
        
        .. code:: bash
        
            pip install frankfurt
        
        Quickstart
        ----------
        
        As expected, a model can be defined as follows:
        
        >>> from frankfurt import Model
        >>> from frankfurt import fields
        >>>
        >>> class FirstModel(Model):
        ...    text = fields.CharField(max_length=200)
        >>>
        >>> m = FirstModel(text='example')
        >>> m['text']
        'example'
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: AsyncIO
Classifier: Topic :: Database
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
