pyactiverecord 0.4.2
pyactiverecord is python active record like mysql wrapper.
License: MIT
Keywords: db,mysql,active record,ORM

pyactiverecord
==============

pyactiverecord is python active-record like mysql wrapper.

Features
--------

-  active-record like mysql wrapper
-  ORM

Requirements
------------

-  Python 3.x
-  mysql
-  mysql-connector-python

Install
-------

::

    pip install pyactiverecord

Usage
-----

create model class.

::

    import model


    class SampleModel(model.Model):

        number = model.Column(type=model.Type.int)
        title = model.Column(type=modle.Type.varchar)
        text = model.Column(type=model.Type.text)
        date = model.Column(type=model.Type.timestamp)
        

at this time, if the lower-case of this model class name of table is't
exist, table is automatically created.

pyactiverecord needs to connecte to the database, program is required to
call Databese.setup() method.

::

    import model

    def execute():
        s = SampleModel()
        s.title = "test"
        s.text = "test to save sample model"
        s.save()
        
        s = SampleModel.query().first()
        print(s.title, s.text)


    if __name__ == '__main__':
        
        model.Database.setup(
            host="localhost",
            database="database_name",
            user="root",
            password=""
        )
        
        execute()

Methods
-------

class methods
~~~~~~~~~~~~~

query: fetch data from the table

::

    data = SampleModel.query()
    for d in data:
        print(d.title)

    # where
    data = SampleModel.query(where=["title='py-activerecord'", "text like '%Python%'"])

    # order
    data = SampleModel.query(order=["id asc", "title desc"])

instance methods
~~~~~~~~~~~~~~~~

save: save model object to the table

::

    s = SampleModel()
    s.number = 1
    s.title = "py-activerecord"
    s.text = "ActiveRecord for Python Library"
    s.date = "2016-01-01 00:00:00"

    s.save()

delete: delete model object from the table

::

    s = SampleModel.query(where=["title='py-activerecord'"], order=["id asc"]).first()
    s.delete()

License
~~~~~~~

This software is released under the MIT License

The MIT License (MIT)
Copyright (c) 2016 Hiroyuki Nikaido

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.