dsorm 0.0.6

A Darned Simple ORM

Darned Simple ORM

A single file ORM for SQLite in Python

Table of Contents

1. About The Project
2. Getting Started
3. Usage
   • Further Examples
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Darned Simple ORM (dsORM) is a little bit different from other ORMs. The typical ORM approach is to have developers "map" their classes to a database and then do "magic" to make that database work. dsORM aims instead to map database components into easy to use Python objects which can be leveraged by your classes for database interactions.

If SQLAlchemy's expression language comes to mind, yes, this is a bit like that. But dsORM is simple, the entire functional code is in a single file which is currently under 1,000 lines. For comparison, PeeWee, a fairly small ORM is 7,723 lines long in it's main file and that doesn't contain all of it's functional code. SQLAlchemy as of this writing contains 343,975 lines of Python code (though admittedly it dwarfs dsORM's feature set.)

Designed for easy integration / modification

• 100% Python
• No external dependencies
• 100% test coverage
• Functional code in a single file

Should I use this?

You should not use dsORM if:

• You need a fully featured and robust ORM supporting multiple back ends
• You don't have any idea how SQL works and need maximal hand holding
• You want something that enforces best practices

You should use dsORM if:

• You know SQL enough to get around and want to avoid some boilerplate
• You are prototyping and want something minimal to stand in for another ORM
• You want to make your own project tailored ORM and can use dsORM as a starting point
• You cannot pip install in your environment and need a single file solution that can be bundled

Getting Started

To get a local copy up and running follow these simple steps.

Installing with pip

pip install dsorm

For information about cloning and dev setup see: Contributing

Usage

Here is an example showing basic usage.

from dsorm import Column, Database, Table, Where

Person = Table(
    name="person",
    column=[
        Column.id(),  # This is shorthand for Column("id", int, pkey=True)
        Column("first_name", nullable=False),
        Column("last_name", nullable=False),
    ],
)

# Database instances can access any table with insert, query, or delete.
Database.default_db = ":memory:"
db = Database()
db.init_db()  # This creates all tables

# Insert records
db.insert(
    table="person",
    data=[
        {"first_name": "Jane", "last_name": "Doe"},
        {"first_name": "John", "last_name": "Doe"},
    ],
)

# Query returns a list of dicts of rows matching the where
does = db.query(
    "person",
    where={"first_name": Where.like(target="J%n%")},
    columns=[
        "id",
        "first_name || ' ' || last_name AS full_name",  # Note that the columns can be sql
    ],
)
print(does)
# [{"id": 1, "full_name": "John Doe"}, {"id": 2, "full_name": "Jane Doe"}]

# And Delete
db.delete("person", where={"id": does[0]["id"]})
print([r["id"] for r in db.query("person")])
# [2]

It's darned simple.

Further Examples

• A Practical Example
• Custom Type Handling & Column Defaults
• Advanced WHERE clauses
• Configuration
• Statements

Roadmap

Needed features:

• JOIN between objects
• Grouping/Aggregates
• Order/Limit/Offset

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Add tests, we aim for 100% test coverage Using Coverage
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

Cloning / Development setup

1. Clone the repo and install

   git clone https://github.com/kajuberdut/dsorm.git
   cd dsorm
   pipenv install --dev
   

2. Run tests

   pipenv shell
   py.test
   

For more about pipenv see: Pipenv Github

License

Distributed under the BSD Two-clause License. See LICENSE for more information.

Contact

Patrick Shechet - [e-mail]

Project Link: https://github.com/kajuberdut/dsorm