pyramid-basemodel 0.1__tar.gz

pyramid_basemodel-0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include UNLICENSE *.md *.py
+recursive-include src *.py

pyramid_basemodel-0.1/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 1.0
+Name: pyramid_basemodel
+Version: 0.1
+Summary: Global base classes for Pyramid SQLAlchemy applications.
+Home-page: http://github.com/thruflo/pyramid_basemodel
+Author: James Arthur
+Author-email: username: thruflo, domain: gmail.com
+License: This is free and unencumbered software released into the public domain.
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: Public Domain
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Framework :: Pylons
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
+Classifier: Topic :: Software Development :: Libraries :: Python Modules

pyramid_basemodel-0.1/README.md

@@ -0,0 +1,5 @@
+[pyramid_basemodel][] is a thin, low level package that provides an SQLAlchemy
+declarative `Base` and a thread local scoped `Session` that can be used by
+different packages whilst only needing to be bound to a db engine once.
+
+[pyramid_basemodel]: http://github.com/thruflo/pyramid_basemodel

pyramid_basemodel-0.1/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

pyramid_basemodel-0.1/setup.cfg

@@ -0,0 +1,5 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+tag_svn_revision = 0
+

pyramid_basemodel-0.1/setup.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from os.path import dirname, join as join_path
+from setuptools import setup, find_packages
+
+def _read(file_name):
+    sock = open(file_name)
+    text = sock.read()
+    sock.close()
+    return text
+    
+
+
+setup(
+    name = 'pyramid_basemodel',
+    version = '0.1',
+    description = 'Global base classes for Pyramid SQLAlchemy applications.',
+    author = 'James Arthur',
+    author_email = 'username: thruflo, domain: gmail.com',
+    url = 'http://github.com/thruflo/pyramid_basemodel',
+    classifiers = [
+        'Development Status :: 3 - Alpha',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: Public Domain',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.2',
+        'Framework :: Pylons',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: WSGI',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+    license = _read('UNLICENSE').split('\n')[0],
+    packages = find_packages('src'),
+    package_dir = {'': 'src'},
+    include_package_data = True,
+    zip_safe = False,
+    install_requires=[
+        'pyramid_tm',
+        'pyramid',
+        'zope.sqlalchemy',
+        'SQLAlchemy'
+    ]
+)

pyramid_basemodel-0.1/src/pyramid_basemodel/__init__.py

@@ -0,0 +1,153 @@
+# -*- coding: utf-8 -*-
+
+"""Provides global scoped ``Session`` and declarative ``Base``, ``BaseMixin``
+  class and ``bind_engine`` function.
+  
+  To use, import and, e.g.: inherit from the base classes::
+  
+      >>> class MyModel(Base, BaseMixin):
+      ...     __tablename__ = 'my_model'
+      ... 
+      >>> instance = MyModel()
+      >>> Session.add(instance)
+      >>> # etc.
+  
+  To automatically bind the base metadata and session to your db engine, just
+  include the package::
+  
+      config.include('pyramid_basemodel')
+  
+"""
+
+__all__ = [
+    'Base',
+    'BaseMixin',
+    'Session',
+    'bind_engine',
+]
+
+from datetime import datetime
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import Column, DateTime, Integer
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import scoped_session, sessionmaker
+from zope.sqlalchemy import ZopeTransactionExtension
+
+Session = scoped_session(sessionmaker(extension=ZopeTransactionExtension()))
+Base = declarative_base()
+
+class BaseMixin(object):
+    """Provides an int ``id`` as primary key, ``version``, ``created`` and
+      ``modified`` columns and a scoped ``self.query`` property.
+    """
+    
+    id =  Column(Integer, primary_key=True)
+    
+    version = Column('v', Integer, default=1)
+    created = Column('c', DateTime, default=datetime.utcnow)
+    modified = Column('m', DateTime, default=datetime.utcnow, onupdate=datetime.utcnow)
+    
+    query = Session.query_property()
+
+
+def save(instance_or_instances, session=Session):
+    """Save model instance(s) to the db.
+      
+      Setup::
+      
+          >>> from mock import Mock
+          >>> mock_session = Mock()
+      
+      A single instance is added to the session::
+      
+          >>> save('a', session=mock_session)
+          >>> mock_session.add.assert_called_with('a')
+      
+      Multiple instances are all added at the same time::
+      
+          >>> save(['a', 'b'], session=mock_session)
+          >>> mock_session.add_all.assert_called_with(['a', 'b'])
+      
+    """
+    
+    v = instance_or_instances
+    if isinstance(v, list) or isinstance(v, tuple):
+        session.add_all(v)
+    else:
+        session.add(v)
+
+def bind_engine(engine, session=Session, base=Base, should_drop=False):
+    """Bind the ``session`` and ``base`` to the ``engine``.
+      
+      Setup::
+      
+          >>> from mock import Mock
+          >>> mock_session = Mock()
+          >>> mock_base = Mock()
+          >>> mock_engine = Mock()
+      
+      Binds the session::
+      
+          >>> bind_engine(mock_engine, session=mock_session, base=mock_base)
+          >>> mock_session.configure.assert_called_with(bind=mock_engine)
+      
+      Binds the base metadata::
+      
+          >>> mock_base.metadata.bind == mock_engine
+          True
+      
+      Creates tables if they don't exist::
+      
+          >>> mock_base.metadata.create_all.assert_called_with(mock_engine)
+      
+      Drops tables if ``should_drop`` is ``True``::
+      
+          >>> mock_base.metadata.drop_all.called
+          False
+          >>> bind_engine(mock_engine, session=mock_session, base=mock_base,
+          ...             should_drop=True)
+          >>> mock_base.metadata.drop_all.assert_called_with(mock_engine)
+      
+    """
+    
+    session.configure(bind=engine)
+    base.metadata.bind = engine
+    if should_drop:
+        base.metadata.drop_all(engine)
+    base.metadata.create_all(engine)
+
+def includeme(config):
+    """Bind to the db engine specifed in ``config.registry.settings``.
+      
+      Setup::
+      
+          >>> from mock import Mock
+          >>> import pyramid_basemodel
+          >>> _engine_from_config = pyramid_basemodel.engine_from_config
+          >>> _bind_engine = pyramid_basemodel.bind_engine
+          >>> pyramid_basemodel.engine_from_config = Mock()
+          >>> pyramid_basemodel.engine_from_config.return_value = 'engine'
+          >>> pyramid_basemodel.bind_engine = Mock()
+          >>> mock_config = Mock()
+          >>> mock_config.registry.settings = {}
+      
+      Calls ``bind_engine`` with the configured ``engine``::
+      
+          >>> includeme(mock_config)
+          >>> pyramid_basemodel.bind_engine.assert_called_with('engine', 
+          ...                                                  should_drop=False)
+      
+      Teardown::
+      
+          >>> pyramid_basemodel.engine_from_config = _engine_from_config
+          >>> pyramid_basemodel.bind_engine = _bind_engine 
+      
+    """
+    
+    # Bind the engine.
+    settings = config.registry.settings
+    engine = engine_from_config(settings, 'sqlalchemy.')
+    should_drop = settings.get('basemodel.should_drop_all', False)
+    bind_engine(engine, should_drop=should_drop)
+

pyramid_basemodel-0.1/src/pyramid_basemodel.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 1.0
+Name: pyramid-basemodel
+Version: 0.1
+Summary: Global base classes for Pyramid SQLAlchemy applications.
+Home-page: http://github.com/thruflo/pyramid_basemodel
+Author: James Arthur
+Author-email: username: thruflo, domain: gmail.com
+License: This is free and unencumbered software released into the public domain.
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: Public Domain
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Framework :: Pylons
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
+Classifier: Topic :: Software Development :: Libraries :: Python Modules

pyramid_basemodel-0.1/src/pyramid_basemodel.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+MANIFEST.in
+README.md
+UNLICENSE
+setup.py
+src/pyramid_basemodel/__init__.py
+src/pyramid_basemodel.egg-info/PKG-INFO
+src/pyramid_basemodel.egg-info/SOURCES.txt
+src/pyramid_basemodel.egg-info/dependency_links.txt
+src/pyramid_basemodel.egg-info/not-zip-safe
+src/pyramid_basemodel.egg-info/requires.txt
+src/pyramid_basemodel.egg-info/top_level.txt

pyramid_basemodel-0.1/src/pyramid_basemodel.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyramid_basemodel-0.1/src/pyramid_basemodel.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

pyramid_basemodel-0.1/src/pyramid_basemodel.egg-info/requires.txt

@@ -0,0 +1,4 @@
+pyramid_tm
+pyramid
+zope.sqlalchemy
+SQLAlchemy

pyramid_basemodel-0.1/src/pyramid_basemodel.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyramid_basemodel