sqlite-orm 0.0.1b0

A Python object relational mapper for SQLite.

# python-sqlite-orm

A Python object relational mapper for SQLite.


## Tutorial

* Install

```sh
pip install sqlite-orm
```

* Define a Post model in a `post.py` file.

```py
# post.py

from orm import Model

class Post(Model):

text = str # other datatypes: int, float

def __init__(self, text):
self.text = text

```

* Import `Database` to create a data access object (DAO).

```py
>>> from orm import Database
>>> db = Database('db.sqlite') # indicating a database file.
```

* Import the Post model and link it to the database.

```py
>>> from post import Post
>>> Post.db = db # see another approach in tests.py
```

* Create a post and save it in the staging area (without commit) of database.

```py
>>> post = Post('Hello World').save()
>>> print(post.id) # auto generated id
1
```

* Change the hello world post and update it in the database.

```py
>>> post.text = 'Hello Mundo'
>>> post.update()
>>> post.text
Hello Mundo
```

* Commit all staged operations (`save` and `update`) to the database.

```py
>>> db.commit()
```

* Delete the object and commit.

```py
>>> post.delete()
>>> db.commit()
```

* Create a manager that can perform CRUD operations in the database.

```py
>>> objects = Post.manager(db)
```

Save and get a post.

```py
>>> objects.save(Post('Hello', 'World'))
>>> objects.get(2) # get by id from the staging area
{'text': 'World', 'id': 2, 'title': 'Hello'}
```

* Close the database without commit the changes

```py
>>> db.close()
```

Get all posts from database.

```py
>>> list(objects.all()) # return a "empty" generator
[]
```

## Contributing

See CONTRIBUTING.

## License

[](https://creativecommons.org/licenses/by-nc-sa/4.0/)

The MIT License.

-

Copyright (c) 2014-2016 [Fernando Felix do Nascimento Junior](https://github.com/fernandojunior/).