summaryrefslogtreecommitdiff
path: root/README
blob: 28f843e99170f5ee7e58b23c18f903dec598b7e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
SQLAlchemy
++++++++++

The Python SQL Toolkit and Object Relational Mapper

Requirements
------------

SQLAlchemy requires Python 2.3 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.

Installing
----------

To install::

  python setup.py install

To use without installation, include the ``lib`` directory in your Python
path.

Package Contents
----------------

  doc/
     HTML documentation, including tutorials and API reference.

  examples/
     Fully commented and executable implementations for a variety of tasks.

  lib/
     SQLAlchemy.

  test/
     Unit tests for SQLAlchemy.  See ``README.unittests`` for more
     information.

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>`_.