Installation

To install ORMithorynque, type the following command into the command prompt (with root permission):

pip install ormithorynque

What can I do with ORMithorynque?

Open an ORMithorynque database from a filename (if the database does not exist, it is automatically created):

>>> import ormithorynque

>>> database = ormithorynque.Database("database_filename.sqlite3")

Create two classes, with a one-to-many relation between them (tables are automatically created with the class if they do not exist; if they exist, they are automatically updated with new column if needed):

>>> class Person(database.Object):
...     name       = database.SQLAttribute(str, indexed = True)
...     first_name = database.SQLAttribute(str)
...     houses     = database.SQLOneToMany("House", "owner")

>>> class House(database.Object):
...     address = database.SQLAttribute("Nowhere") # String attribute with a default value
...     owner   = database.SQLAttribute(object)

Create two instances (database is automatically updated):

>>> someone = Person(name = "Some", first_name="One")

>>> house = House(address = "Somewhere", owner = someone)

The attributes of the instances can be accessed and modified (database is automatically update):

>>> someone.name
Some
>>> someone.name = "Some2"

>>> someone.houses
[<House id=2 address='Somewhere' owner=<Person id=1 first_name='One' name='Some2'>>]

Finally, plain SQL can be used to query the database:

>>> database.select_one("select count(id) from Person")
(1,)

Changelog

Links

ORMithorynque on BitBucket (development repository): https://bitbucket.org/jibalamy/ormithorynque

ORMithorynque on PyPI (Python Package Index, stable release): https://pypi.python.org/pypi/ormithorynque

Documentation: http://pythonhosted.org/ORMithorynque

Mail me for any comment, problem, suggestion or help !

Jiba – Jean-Baptiste LAMY – jibalamy @ free.fr