/
README
80 lines (54 loc) · 1.85 KB
/
README
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
--------------------------
If installing with Setuptools or Distribute, the C extensions are built
and installed using the --with-cextensions flag:
python setup.py --with-cextensions install
If using plain Distutils, change the BUILD_CEXTENSIONS flag in setup.py
to "True".
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>`_.