butterdb is a Python ORM for Google Drive Spreadsheets.
Project description
butterdb
========
| Master: |Build Status|
| Develop: |Build Status|
`Documentation`_
`butterdb on PyPi`_
butterdb is a Python ORM for Google Drive Spreadsheets. Never use this for anything important, it's an experiment.
Installation
------------
``pip install butterdb``
Usage
-----
::
import butterdb
database = butterdb.Database("MyDatabaseSheet", "foo@google.com", "password")
@butterdb.register(database)
class User(butterdb.Model):
def __init__(self, name, password):
self.name = self.field(name)
self.password = self.field(password)
barry = User("Barry", "hunter2")
barry.name = "Steve"
barry.commit()
users = User.get_instances()
Tests
-----
`nosetests`
What works?
----------
* Store data in Google Spreadsheets (the cloud!!!)
* Models from classes
* Fields as attributes. decimals, ints and strings only (as far as I know)
* Commits
* Mocked unit tests, mock database
* Arbitrary cell execution with `=blah()` (free stored procedures?)
* Auto backup/bad patch control
What's missing?
---------------
* Spreadsheets must exist before connecting
* References
* Collections
* Customizable fields
* Customizable table size (arbitrarily hardcoded)
Feedback
--------
Comments, concerns, issues and pull requests welcomed. Reddit /u/Widdershiny or email me at ncwjohnstone@gmail.com.
License
-------
MIT License. See LICENSE file for full text.
.. _Documentation: http://butterdb.readthedocs.org
.. _butterdb on PyPi: https://pypi.python.org/pypi/butterdb
.. |Build Status| image:: https://travis-ci.org/Widdershin/butterdb.png?branch=master
:target: https://travis-ci.org/Widdershin/butterdb
.. |Build Status| image:: https://travis-ci.org/Widdershin/butterdb.png?branch=develop
:target: https://travis-ci.org/Widdershin/butterdb
History
-------
0.1.0 7/3/14
++++++++++++++++++
* First release on PyPI.
0.1.1 7/3/14
++++++++++++++++++
* Converted readme to rst from md
0.1.2 7/3/14
++++++++++++++++++
* Included HISTORY.rst in package build
0.1.3 7/3/14
++++++++++++++++++
* Model.field no longer requires name to be specified. Attribute name will be used if none is provided.
* Model no longer needs to have id as a keyword argument, or call super in init
* Tests now use pep8 asserts
========
| Master: |Build Status|
| Develop: |Build Status|
`Documentation`_
`butterdb on PyPi`_
butterdb is a Python ORM for Google Drive Spreadsheets. Never use this for anything important, it's an experiment.
Installation
------------
``pip install butterdb``
Usage
-----
::
import butterdb
database = butterdb.Database("MyDatabaseSheet", "foo@google.com", "password")
@butterdb.register(database)
class User(butterdb.Model):
def __init__(self, name, password):
self.name = self.field(name)
self.password = self.field(password)
barry = User("Barry", "hunter2")
barry.name = "Steve"
barry.commit()
users = User.get_instances()
Tests
-----
`nosetests`
What works?
----------
* Store data in Google Spreadsheets (the cloud!!!)
* Models from classes
* Fields as attributes. decimals, ints and strings only (as far as I know)
* Commits
* Mocked unit tests, mock database
* Arbitrary cell execution with `=blah()` (free stored procedures?)
* Auto backup/bad patch control
What's missing?
---------------
* Spreadsheets must exist before connecting
* References
* Collections
* Customizable fields
* Customizable table size (arbitrarily hardcoded)
Feedback
--------
Comments, concerns, issues and pull requests welcomed. Reddit /u/Widdershiny or email me at ncwjohnstone@gmail.com.
License
-------
MIT License. See LICENSE file for full text.
.. _Documentation: http://butterdb.readthedocs.org
.. _butterdb on PyPi: https://pypi.python.org/pypi/butterdb
.. |Build Status| image:: https://travis-ci.org/Widdershin/butterdb.png?branch=master
:target: https://travis-ci.org/Widdershin/butterdb
.. |Build Status| image:: https://travis-ci.org/Widdershin/butterdb.png?branch=develop
:target: https://travis-ci.org/Widdershin/butterdb
History
-------
0.1.0 7/3/14
++++++++++++++++++
* First release on PyPI.
0.1.1 7/3/14
++++++++++++++++++
* Converted readme to rst from md
0.1.2 7/3/14
++++++++++++++++++
* Included HISTORY.rst in package build
0.1.3 7/3/14
++++++++++++++++++
* Model.field no longer requires name to be specified. Attribute name will be used if none is provided.
* Model no longer needs to have id as a keyword argument, or call super in init
* Tests now use pep8 asserts