source: trunk/docs/readme.txt @ 339

Last change on this file since 339 was 339, checked in by cito, 11 years ago

Mention PyPI in the "Where to get" section.

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