Files
sqlalchemy/README
T
Gaëtan de Menten 165609a190 - Added an optional C extension to speed up the sql layer by
reimplementing the highest impact functions.
  The actual speedups will depend heavily on your DBAPI and
  the mix of datatypes used in your tables, and can vary from
  a 50% improvement to more than 200%. It also provides a modest
  (~20%) indirect improvement to ORM speed for large queries.
  Note that it is *not* built/installed by default.
  See README for installation instructions.

- The most common result processors conversion function were
  moved to the new "processors" module.  Dialect authors are
  encouraged to use those functions whenever they correspond
  to their needs instead of implementing custom ones.
2010-02-13 22:53:39 +00:00

79 lines
1.8 KiB
Plaintext

SQLAlchemy
++++++++++
The Python SQL Toolkit and Object Relational Mapper
Requirements
------------
SQLAlchemy requires Python 2.4 or higher. One or more DB-API implementations
are also required for database access. See docs/intro.html for more
information on supported DB-API implementations.
Python 3 Compatibility
----------------------
Please see README.py3k for Python 3 installation and testing instructions.
Installation Tools
------------------
Installation is supported with standard Python distutils, as well
as with setuptools or Distribute. Distribute is recommended.
Distribute can be installed using the provided "distribute_setup.py"
script. The original setuptools may be installed using the
"ez_setup.py" script if preferred, or simply do nothing and distutils
will be used.
Installing
----------
To install::
python setup.py install
To use without installation, include the ``lib`` directory in your Python
path.
Installing the C extension
--------------------------
Edit "setup.py" and set ``BUILD_CEXTENSIONS`` to ``True``, then install it as
above. If you want only to build the extension and not install it, you can do
so with::
python setup.py build
Running Tests
-------------
Please see README.unittests for full instructions on running unit tests.
Package Contents
----------------
doc/
HTML documentation, including tutorials and API reference. Point
a browser to the "index.html" to start.
examples/
Fully commented and executable implementations for a variety of tasks.
lib/
SQLAlchemy.
test/
Unit tests for SQLAlchemy.
Help
----
Mailing lists, wiki, and more are available on-line at
http://www.sqlalchemy.org.
License
-------
SQLAlchemy is distributed under the `MIT license
<http://www.opensource.org/licenses/mit-license.php>`_.