Python Makefile
Switch branches/tags
Nothing to show
Latest commit b16166d Jul 30, 2017 @jpscaletti jpscaletti Merge pull request #20 from fergushmackenzie/documentation-update
Changed misleading documentation.

README.rst

SQLAlchemy-Wrapper Build Status

A friendly wrapper for SQLAlchemy.

from sqlalchemy_wrapper import SQLAlchemy

db = SQLAlchemy('sqlite:///:memory:')

class ToDo(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    ...

db.create_all()
todos = db.query(ToDo).all()

Read the complete documentation here: http://sqlawrapper.lucuma.co

SQLAlchemy-Wrapper was born as a framework-independent fork of Flask-SQLAlchemy. Read about the goals of the project in the About SQLAlchemy-Wrapper section of the documentation.

Works with Python 2.7, 3.3+ and pypy.

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the SQLAlchemy-Wrapper repository on Github to start making your changes.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS.

Run the tests

We use some external dependencies, listed in requirements_tests.txt:

$  pip install -r requirements-tests.txt
$  python setup.py install

To run the tests in your current Python version do:

$  make test

To run them in every supported Python version do:

$  tox

It's also neccesary to run the coverage report to make sure all lines of code are touch by the tests:

$  make coverage

Our test suite runs continuously on Travis CI with every update.

copyright:2012-2015 by Juan-Pablo Scaletti.
license:BSD, see LICENSE for more details.

Some of the code was extracted and adapted from Flask-SQLAlchemy

copyright:2010-2014 by Armin Ronacher.
license:BSD, see LICENSE for more details.