~ubuntu-branches/debian/sid/sqlalchemy/sid

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Piotr Ożarowski
  • Date: 2012-01-29 23:29:50 UTC
  • mfrom: (1.4.18)
  • Revision ID: package-import@ubuntu.com-20120129232950-1mw4zn2xy2o51ua5
Tags: 0.7.5-1
* New upstream release
  - minumum required python-sphinx version bumped to 1.1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
SQLAlchemy
2
 
++++++++++
3
 
 
4
 
The Python SQL Toolkit and Object Relational Mapper
5
 
 
6
 
Requirements
7
 
------------
8
 
 
9
 
SQLAlchemy requires Python 2.4 or higher.  One or more DB-API implementations
10
 
are also required for database access.  See docs/intro.html for more
11
 
information on supported DB-API implementations.
12
 
 
13
 
Python 3 Compatibility
14
 
----------------------
15
 
 
16
 
Please see README.py3k for Python 3 installation and testing instructions.
17
 
 
18
 
Installation Tools
19
 
------------------
20
 
 
21
 
Installation is supported with standard Python distutils, as well
22
 
as with setuptools or Distribute.  Distribute is recommended.
23
 
Distribute can be installed using the provided "distribute_setup.py" 
24
 
script.  The original setuptools may be installed using the 
25
 
"ez_setup.py" script if preferred, or simply do nothing and distutils
26
 
will be used.
27
 
 
28
 
Installing
29
 
----------
30
 
 
31
 
To install::
32
 
 
33
 
  python setup.py install
34
 
 
35
 
To use without installation, include the ``lib`` directory in your Python
36
 
path.
37
 
 
38
 
Running Tests
39
 
-------------
40
 
 
41
 
Please see README.unittests for full instructions on running unit tests.
42
 
 
43
 
Package Contents
44
 
----------------
45
 
 
46
 
  doc/
47
 
     HTML documentation, including tutorials and API reference.  Point
48
 
     a browser to the "index.html" to start.
49
 
 
50
 
  examples/
51
 
     Fully commented and executable implementations for a variety of tasks.
52
 
 
53
 
  lib/
54
 
     SQLAlchemy.
55
 
 
56
 
  test/
57
 
     Unit tests for SQLAlchemy.
58
 
 
59
 
Help
60
 
----
61
 
 
62
 
Mailing lists, wiki, and more are available on-line at
63
 
http://www.sqlalchemy.org.
64
 
 
65
 
License
66
 
-------
67
 
 
68
 
SQLAlchemy is distributed under the `MIT license
69
 
<http://www.opensource.org/licenses/mit-license.php>`_.
70