Skip to main content

pyactiverecord is python active record like mysql wrapper.

Project description

# 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, see [LICENSE.md](./LICENSE.md)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pyactiverecord-0.3.0.tar.gz (5.0 kB) Copy SHA256 hash SHA256 Source None May 9, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page