Source

sqlamp / README

Full commit
======
sqlamp
======
An implementation of Materialized Path for SQLAlchemy.


Requirements
------------
Requires SQLAlchemy >= 0.5. Known to work well with python 2.6 but should
also work with python 2.4+. Known-to-work supported DBMS include sqlite
(tested with 3.6.14), MySQL (tested using both MyISAM and InnoDB with
server version 5.1.34) and PostgreSQL (tested with 8.3.7), but sqlamp
should work with any other DBMS supported by SQLAlchemy.


Support
-------
Feel free to email author directly to send bugreports, feature requests,
patches, etc.


Installation
------------
To install type as usual::

  python setup.py install

Or drop ``sqlamp`` directory somewhere in your PYTHONPATH.


Documentation
-------------
You can view a full documentation by doing `make html` in `doc` dir
and open result `index.html` file in your browser.


Package Contents
----------------
  doc/
      documentation index in rst-format, can be built using makefile
      included.

  sqlamp/
      source code of the project.

  tests/
      unittests for sqlamp.


License
-------
sqlamp is licensed under 2-clause BSD license, see LICENSE for more
details.