source: trunk/docs/readme.txt @ 350

Last change on this file since 350 was 350, checked in by darcy, 11 years ago

Break up a long line.

File size: 6.9 KB
Line 
1==========================================
2PyGreSQL - Python interface for PostgreSQL
3==========================================
4
5--------------------
6PyGreSQL version 4.0
7--------------------
8
9.. meta::
10   :description: PyGreSQL - Python interface for PostgreSQL
11   :keywords: PyGreSQL, PostGreSQL, Python
12
13.. contents:: Contents
14
15
16Copyright notice
17================
18
19Written by D'Arcy J.M. Cain (darcy@druid.net)
20
21Based heavily on code written by Pascal Andre (andre@chimay.via.ecp.fr)
22
23Copyright (c) 1995, Pascal Andre
24
25Further modifications copyright (c) 1997-2008 by D'Arcy J.M. Cain
26(darcy@druid.net)
27
28Permission to use, copy, modify, and distribute this software and its
29documentation for any purpose, without fee, and without a written agreement
30is hereby granted, provided that the above copyright notice and this
31paragraph and the following two paragraphs appear in all copies or in any
32new file that contains a substantial portion of this file.
33
34IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
35SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
36ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE
37AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
39THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED
40TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE
42AUTHOR HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
43ENHANCEMENTS, OR MODIFICATIONS.
44
45
46Introduction
47============
48
49**PostgreSQL** is a highly scalable, SQL compliant, open source
50object-relational database management system. With more than 15 years
51of development history, it is quickly becoming the de facto database
52for enterprise level open source solutions.
53Best of all, PostgreSQL's source code is available under the most liberal
54open source license: the BSD license.
55
56**Python** Python is an interpreted, interactive, object-oriented
57programming language. It is often compared to Tcl, Perl, Scheme or Java.
58Python combines remarkable power with very clear syntax. It has modules,
59classes, exceptions, very high level dynamic data types, and dynamic typing.
60There are interfaces to many system calls and libraries, as well as to
61various windowing systems (X11, Motif, Tk, Mac, MFC). New built-in modules
62are easily written in C or C++. Python is also usable as an extension
63language for applications that need a programmable interface.
64The Python implementation is copyrighted but freely usable and distributable,
65even for commercial use.
66
67**PyGreSQL** is a Python module that interfaces to a PostgreSQL database.
68It embeds the PostgreSQL query library to allow easy use of the powerful
69PostgreSQL features from a Python script.
70
71PyGreSQL is developed and tested on a NetBSD system, but it should also
72run on most other platforms where PostgreSQL and Python is running.
73It is based on the PyGres95 code written by Pascal Andre (andre@chimay.via.ecp.fr).
74D'Arcy (darcy@druid.net) renamed it to PyGreSQL starting with
75version 2.0 and serves as the "BDFL" of PyGreSQL.
76
77The current version PyGreSQL 4.0 needs PostgreSQL 7.2 and Python 2.3 or above.
78
79
80Where to get ... ?
81==================
82
83Home sites of the different packages
84------------------------------------
85**Python**:
86  http://www.python.org
87
88**PostgreSQL**:
89  http://www.postgresql.org
90
91**PyGreSQL**:
92  http://www.pygresql.org
93
94Download PyGreSQL here
95----------------------
96The **released version of the source code** is available at
97  * ftp://ftp.pygresql.org/pub/distrib/PyGreSQL.tgz
98You can also check the latest **pre-release version** at
99  * ftp://ftp.pygresql.org/pub/distrib/PyGreSQL-beta.tgz
100A **Linux RPM** can be picked up from
101  * ftp://ftp.pygresql.org/pub/distrib/pygresql.i386.rpm
102A **NetBSD package** is available in their pkgsrc collection
103  * ftp://ftp.netbsd.org/pub/NetBSD/packages/pkgsrc/databases/py-postgresql/README.html
104A **FreeBSD package** is available in their ports collection
105  * http://www.freebsd.org/cgi/cvsweb.cgi/ports/databases/py-PyGreSQL/
106A **Win32 package** for various Python versions is available at
107  * ftp://ftp.pygresql.org/pub/distrib/PyGreSQL-4.0.win32-py2.2.exe
108  * ftp://ftp.pygresql.org/pub/distrib/PyGreSQL-4.0.win32-py2.3.exe
109  * ftp://ftp.pygresql.org/pub/distrib/PyGreSQL-4.0.win32-py2.4.exe
110  * ftp://ftp.pygresql.org/pub/distrib/PyGreSQL-4.0.win32-py2.5.exe
111You can also find PyGreSQL on the **Python Package Index** at
112 * http://pypi.python.org/pypi/PyGreSQL/
113
114
115Distribution files
116==================
117
118========== =
119pgmodule.c the C Python module (_pg)
120pg.py      the "classic" PyGreSQL module
121pgdb.py    DB-SIG DB-API 2.0 compliant API wrapper for PygreSQL
122docs/      documentation directory
123
124           Contains: readme.txt, announce.txt, install.txt,
125           changelog.txt, future.txt, pg.txt and pgdb.txt.
126
127           All text files are in ReST format, so HTML versions
128           can be easily created with buildhtml.py from docutils.
129tutorial/  demos directory
130
131           Contains: basics.py, syscat.py, advanced.py and func.py.
132
133           The samples here have been taken from the
134           PostgreSQL manual and were used for module testing.
135           They demonstrate some PostgreSQL features.
136========== =
137
138
139Installation
140============
141You will find the installing instructions in
142`install.txt <install.html>`_.
143
144
145Information and support
146=======================
147
148For general information
149-----------------------
150**Python**:
151  http://www.python.org
152
153**PostgreSQL**:
154  http://www.postgresql.org
155
156**PyGreSQL**:
157  http://www.pygresql.org
158
159For support
160-----------
161**Python**:
162  see http://www.python.org/community/
163
164**PostgreSQL**:
165  see http://www.postgresql.org/support/
166
167**PyGreSQL**:
168  Contact the PyGreSQL mailing list
169  concerning PyGreSQL 2.0 and up.
170
171  If you would like to proposes changes, please join the
172  PyGreSQL mailing list and send context diffs there.
173
174  See http://mailman.vex.net/mailman/listinfo/pygresql
175  to join the mailing list.
176
177Please note that messages to individual developers will generally not be
178answered directly.  All questions, comments and code changes must be
179submitted to the mailing list for peer review and archiving.
180
181PyGreSQL programming information
182--------------------------------
183You may either choose to use the "classic" PyGreSQL interface
184provided by the `pg` module or else the newer DB-API 2.0
185compliant interface provided by the `pgdb` module.
186
187`DB-API 2.0 <http://www.python.org/peps/pep-0249.html>`_
188(Python Database API Specification v2.0)
189is a specification for connecting to databases (not only PostGreSQL)
190from Python that has been developed by the Python DB-SIG in 1999.
191
192The programming information is available in the files
193`pg.txt <pg.html>`_ and `pgdb.txt <pgdb.html>`_.
194
195
196ChangeLog and Future
197====================
198The ChangeLog with past changes is in the file
199`changelog.txt <changelog.html>`_.
200
201A to do list and wish list is in the file
202`future.txt <future.html>`_.
Note: See TracBrowser for help on using the repository browser.