Skip to main content

Marguerite provides a declarative, consistent accessor to data layer.

Project description

Marguerite

Marguerite provides a declarative, consistent accessor to data layer.


Dependencies

  • Python 2.7 or later
  • Werkzeug 0.12.7 or later

Installation

$ pip install Marguerite

Usage

Example

Install requests as an example.

$ pip install requests
  1. define data layer accessor, and writen access structure ```python from marguerite import AbstractStructure, AbstractAccessor, Order from marguerite.accessors import bind

class Accessor(AbstractAccessor): def prepare(self, name, value): order = self.structure.get_order(name) return bind(order, value)

def create(self, name, value):
    order = self.prepare(name, value)
    return requests.post(order).json()

def get(self, name, value={}):
    order = self.prepare(name, value)
    return requests.get(order).json()

class UserStructure(AbstractStructure): accessor = Accessor

orders = Order(
    user = "https://example.com/users/:id",
    create = "https://example.com/users/:id?=username=:username"
)

```

  1. get data layer accessor object ```python from marguerite import Marguerite

marguerite = Marguerite() accessor = marguerite.get_accessor(“path.to.UserStructure”) ```

  1. fetch data ```python # execute get logic result = accessor.get(“user”, { “id”: 1 }) print(result) # {“id”: 1, “username”: “john”…}

execute post logic

result = accessor.create(“create”, { “id”: 2, “username”: “marguerite” }) print(result) # {“status”: “success”, {“result”: {“id”: 2, “username”: “marguerite”…}}} ```

SQLAlchemy

$ pip install SQLAlchemy MySQL-python
  1. create database

    mysql> create database marguerite;
    Query OK, 1 row affected (0.00 sec)
    
  2. define database structure ```python from marguerite import Order from marguerite.accessors.sql import SQLAlchemyAccessor from marguerite.structures.sql import SQLAlchemyStructure

class User(SQLAlchemyStructure): struct = { “id”: int(), “name”: str(), “email”: str(), }

orders = Order(
    create_table = """
        CREATE TABLE IF NOT EXISTS __table__(
          id int(11) unsigned NOT NULL AUTO_INCREMENT,
          name varchar(255) NOT NULL DEFAULT '',
          PRIMARY KEY (id)
        ) ENGINE=InnoDB CHARSET=utf8;
    """,

    drop_table = """
        DROP TABLE IF EXISTS __table__
    """,

    insert = """
        INSERT INTO
            __table__(name)
        VALUES
            (:name)
    """,

    select = """
        SELECT
            *
        FROM
            __table__
        WHERE
            id = :id
    """,

    find = """
        SELECT
            *
        FROM
            __table__
        WHERE
            id in (:id1, :id2)
    """
)

```

  1. get database accessor object ```python from marguerite import Marguerite

engine = create_engine(“mysql+mysqldb://root:@localhost:3309/marguerite”)

marguerite = Marguerite(engine) accessor = marguerite.get_accessor(“path.to.User”) ```

  1. create table

    accessor.execute("create_table")
    
  2. check also

    mysql> use marguerite
    Database changed
    mysql> show tables;
    +----------------------+
    | Tables_in_marguerite |
    +----------------------+
    | user                 |
    +----------------------+
    
  3. fetch data ```python # insert record at user table accessor.execute(“insert”, {“name”: “john”})

get record

row = accessor.get(“select”, { “id”: 1 }) print(row) # {“id”: 1, “name”: “john”, “email”: “”}

find records

rows = accessor.find(“find”, { “id1”: 1, “id2”: 2 }) print(rows) # [{“id”: 1, “name”: “john”, “email”: “”}] ```

LICENSE

Apache License 2.0

Project details


Download files

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

Files for Marguerite, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size Marguerite-1.0.2.tar.gz (6.0 kB) File type Source Python version None Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page