Skip to main content

Global base classes for Pyramid SQLAlchemy applications.

Project description

[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.

# Usage

You can use these as base classes for declarative model definitions, e.g.::

from pyramid_basemodel import Base, BaseMixin, Session, save

class MyModel(Base, BaseMixin):
"""Example model class."""

@classmethod
def do_foo(cls):
instance = Session.query(cls).first()
save(instance)


You can then bind these to the `sqlalchemy.url` in your paster `.ini` config by
importing your model and this package, e.g.:

# for example in yourapp.__init__.py
import mymodel

def main(global_config, **settings):
config = Configurator(settings=settings)
config.include('pyramid_basemodel')
config.include('pyramid_tm')
return config.make_wsgi_app()

Or if this is all too much voodoo, you can just use the `bind_engine` function::

from pyramid_basemodel import bind_engine
from mypackage import mymodel

# assuming `engine` is a bound SQLAlchemy engine.
bind_engine(engine)

Note that the `Session` is designed to be used in tandem with [pyramid_tm][].
If you don't include `pyramid_tm`, you'll need to take care of committing
transactions yourself.

# Tests

To run the tests use, e.g.:

nosetests --cover-package=pyramid_base_model --cover-tests --with-doctest --with-coverage pyramid_basemodel
....
Name Stmts Miss Cover Missing
--------------------------------------------------------------
src/pyramid_basemodel/__init__ 32 0 100%
----------------------------------------------------------------------
Ran 4 tests in 0.031s

OK

[pyramid_basemodel]: http://github.com/thruflo/pyramid_basemodel
[pyramid_simpleauth]: http://github.com/thruflo/pyramid_basemodel
[pyramid_tm]: http://pyramid_tm.readthedocs.org

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyramid_basemodel-0.3.5.tar.gz (13.9 kB view details)

Uploaded Source

File details

Details for the file pyramid_basemodel-0.3.5.tar.gz.

File metadata

File hashes

Hashes for pyramid_basemodel-0.3.5.tar.gz
Algorithm Hash digest
SHA256 569d812ba81c62f521fcb25f2db544e30b13a5a376439bcc6646d3d08aa3fa72
MD5 54d5344d1dd52d56237e4434c8f1dd5d
BLAKE2b-256 d7793bccc1e17e360e466c58831ab3bf41f88a5e34a78ceb5b6d331415529865

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page