annotate README.txt @ 90:5c73ebfdb24c

tweaking readme
author catherine@cordelia
date Tue, 20 May 2008 21:06:20 -0400
parents b336d049cac7
children 51e1fe3adf0e
rev   line source
85
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
1 SQLPython is an open-source command-line environment for interacting with an
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
2 Oracle database. It is designed as an alternative to Oracle's SQL*Plus.
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
3
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
4 Installing
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
5 ----------
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
6
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
7 Debian/Ubuntu::
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
8
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
9 $ sudo apt-get install python python-dev python-setuptools
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
10 $ sudo easy_install cx_Oracle
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
11 $ sudo easy_install -UZ sqlpython
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
12
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
13 Windows:
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
14 Download and run executable installers from::
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
15
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
16 http://www.python.org (Python language)
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
17 http://cx-oracle.sourceforge.net/ (cx_Oracle)
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
18 http://pypi.python.org/pypi/sqlpython (sqlpython)
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
19
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
20 Other:
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
21 Python is typically already installed. You'll need its
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
22 development package (python-dev); then easy_install
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
23 cx_Oracle and sqlpython as per Debian.
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
24
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
25 Using
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
26 -----
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
27
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
28 Use sqlpython more or less as you would use SQL*Plus.
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
29
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
30 Read the help. Experiment with UNIX-style and postgresql-style
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
31 commands.
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
32
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
33 Modifying
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
34 ---------
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
35
90
5c73ebfdb24c tweaking readme
catherine@cordelia
parents: 85
diff changeset
36 Modify mysqlpy.py; add `do_mycommand(self, arg)`
5c73ebfdb24c tweaking readme
catherine@cordelia
parents: 85
diff changeset
37 methods to the mysqlpy class to add your own commands.
5c73ebfdb24c tweaking readme
catherine@cordelia
parents: 85
diff changeset
38
5c73ebfdb24c tweaking readme
catherine@cordelia
parents: 85
diff changeset
39 Use `self.stdout.write(txt)` in place of `print txt`
5c73ebfdb24c tweaking readme
catherine@cordelia
parents: 85
diff changeset
40 to make sure your output can be redirected into text
5c73ebfdb24c tweaking readme
catherine@cordelia
parents: 85
diff changeset
41 files or the paste buffer with `>` and `>>`.
85
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
42
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
43 Contributing
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
44 ------------
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
45
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
46 Development trunk is available from::
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
47
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
48 http://www.assembla.com/wiki/show/sqlpython
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
49
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
50 Bugs and suggestions can be filed at::
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
51
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
52 http://www.assembla.com/spaces/sqlpython/tickets
b336d049cac7 bugs found during gcoug talk prep
catherine@localhost
parents:
diff changeset
53