added documentation

Browse Source
This commit is contained in:
Gregor Aisch 2013-04-01 21:32:26 +02:00
parent 7c5779da80
commit b76f11c94c
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
dataset/__init__.py
View File

@ -1,10 +1,20 @@
# shut up useless SA warning: # shut up useless SA warning:
import warnings import warnings
warnings.filterwarnings('ignore', 'Unicode type received non-unicode bind param value.') warnings.filterwarnings(
'ignore', 'Unicode type received non-unicode bind param value.')
from dataset.persistence.database import Database from dataset.persistence.database import Database
from dataset.persistence.table import Table from dataset.persistence.table import Table
def connect(url):
return Database(url)
def connect(url):
""" Opens a new connection to a database. *url* can be any valid `SQLAlchemy engine URL`_. Returns
an instance of :py:class:`dataset.Database.
.. code-block:: python
db = dataset.connect('sqlite:///factbook.db')
.. _SQLAlchemy Engine URL: http://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine
"""
return Database(url)