Skip to content

Commit 3f620a5

Browse files
author
James William Pye
committed
More documentation updates.
1 parent 0cede2a commit 3f620a5

3 files changed

Lines changed: 22 additions & 17 deletions

File tree

postgresql/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@
3232

3333
##
3434
# IRI to base reference documentation.
35-
__pkg_documentation__ = __project_id__ + '/v' + '.'.join([
35+
__pkg_documentation__ = __project_id__ + '/docs/' + '.'.join([
3636
str(x) for x in version_info[:2]
3737
]) + '/'
3838

3939
pg_iri = pg_driver = pg_param = None
4040
def open(iri = None):
4141
"""
4242
Create a `postgresql.api.Connection` to the server referenced by the given
43-
`iri` keyword::
43+
`iri`::
4444
4545
>>> import postgresql
4646
# General Format:

postgresql/documentation/changes.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Changes
77
=======
88
9-
0.8.0 released on 2009-04-02
9+
0.8.0 released on 2009-04-03
1010
----------------------------
1111
1212
Differences from the original pg/python projects.
@@ -26,7 +26,9 @@
2626
* Conditionally DECLARE certain cursors WITH HOLD when outside of blocks.
2727
* Add typed support for fetches from db.cursor_from_id().
2828
* Change the test infrastructure to automatically create a cluster.
29+
* More improvements than I can remember.
2930
"""
31+
3032
__docformat__ = 'reStructuredText'
3133
if __name__ == '__main__':
3234
import sys

postgresql/release/distutils.py

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,26 @@
2323

2424
LONG_DESCRIPTION = """
2525
py-postgresql is a set of Python modules providing interfaces to various parts
26-
of PostgreSQL. Notably, it provides a driver for querying a PostgreSQL database.
26+
of PostgreSQL. Notably, it provides a pure-Python driver + C optimizations for
27+
querying a PostgreSQL database.
2728
28-
Sample PG-API Code
29-
------------------
29+
http://python.projects.postgresql.org
30+
31+
Features:
32+
33+
* Prepared Statement driven interfaces.
34+
* Cluster tools for creating and controlling a cluster.
35+
* Support for most PostgreSQL types: composites, arrays, numeric, lots more.
36+
* COPY support.
37+
38+
Sample PG-API Code::
3039
31-
>>> import postresql
40+
>>> import postgresql
3241
>>> db = postgresql.open('pq://user:password@host:port/database')
3342
>>> db.execute("CREATE TABLE emp (emp_first_name text, emp_last_name text, emp_salary numeric)")
3443
>>> make_emp = db.prepare("INSERT INTO emp VALUES ($1, $2, $3)")
3544
>>> make_emp("John", "Doe", "75,322")
36-
>>> with db.xact:
45+
>>> with db.xact():
3746
... make_emp("Jane", "Doe", "75,322")
3847
... make_emp("Edward", "Johnson", "82,744")
3948
...
@@ -44,7 +53,7 @@
4453
4554
However, PG-API is recommended as it provides greater utility.
4655
47-
Once you get it installed, try out the ``pg_python`` command::
56+
Once installed, try out the ``pg_python`` console script::
4857
4958
$ pg_python -h localhost -p port -U theuser -d database_name
5059
@@ -56,14 +65,8 @@
5665
-------
5766
5867
py-postgresql is not yet another PostgreSQL driver, it's been in development for
59-
years. py-postgresql is the Python 3.0 port of the ``pg_proboscis`` driver and
68+
years. py-postgresql is the Python 3 port of the ``pg_proboscis`` driver and
6069
integration of the other ``pg/python`` projects.
61-
62-
63-
More Information
64-
----------------
65-
66-
http://python.projects.postgresql.org
6770
"""
6871

6972
CLASSIFIERS = [
@@ -157,7 +160,7 @@ def standard_setup_keywords(build_extensions = True, prefix = default_prefix):
157160
d = {
158161
'name' : name,
159162
'version' : version,
160-
'description' : 'PostgreSQL tools pacakges. Driver, API specifications, and cluster tools.',
163+
'description' : 'PostgreSQL driver and tools library.',
161164
'long_description' : LONG_DESCRIPTION,
162165
'author' : 'James William Pye',
163166
'author_email' : 'x@jwp.name',

0 commit comments

Comments
 (0)