Deployment documentation enhancements.

master
baztian 2011-01-27 15:47:46 +01:00
parent 1197f43558
commit 3f30de60de
4 changed files with 67 additions and 31 deletions

View File

@ -150,7 +150,7 @@ distribution for details.
Changelog Changelog
========= =========
- trunk - 0.1.3
- Fixed DB-API_ violation: Use ``curs.execute('foo ?', (bar, baz))`` - Fixed DB-API_ violation: Use ``curs.execute('foo ?', (bar, baz))``
instead of ``curs.execute('foo ?', bar, baz)``. instead of ``curs.execute('foo ?', bar, baz)``.

View File

@ -22,13 +22,21 @@ Build a new release
$ nosetests $ nosetests
3. Add a changelog entry to ``README.rst``. 4. Add a changelog entry to ``README.rst``.
4. Increase version in ``setup.py``. 5. Increase version in ``setup.py``.
5. Run setuptools to ensure everything is working as expected. :: 6. Run setuptools to ensure everything is working as expected. ::
$ python setup.py sdist $ python setup.py sdist --formats=gztar
7. Check the file createt by sdist for unwanted or missing files.
8. Install the sdist in a fresh virtualenv. ::
$ virtualenv tmp
$ . tmp/bin/activate
$ easy_install path_to_build_folder/jaydebeapi-0.x.tar.gz
6. Commit your changes. :: 6. Commit your changes. ::

View File

@ -24,7 +24,7 @@ print find_packages('src')
setup( setup(
#basic package data #basic package data
name = 'JayDeBeApi', name = 'JayDeBeApi',
version = '0.1.2', version = '0.1.3',
author = 'Bastian Bowe', author = 'Bastian Bowe',
author_email = 'bastian.bowe@gmail.com', author_email = 'bastian.bowe@gmail.com',
license = 'GNU LGPL', license = 'GNU LGPL',

View File

@ -1,14 +1,14 @@
Metadata-Version: 1.0 Metadata-Version: 1.0
Name: JayDeBeApi Name: JayDeBeApi
Version: 0.1.2 Version: 0.1.3
Summary: A bridge from JDBC database drivers to Python DB-API. Summary: A bridge from JDBC database drivers to Python DB-API.
Home-page: https://launchpad.net/jaydebeapi Home-page: https://launchpad.net/jaydebeapi
Author: Bastian Bowe Author: Bastian Bowe
Author-email: bastian.bowe@gmail.com Author-email: bastian.bowe@gmail.com
License: GNU LGPL License: GNU LGPL
Description: ===================================================================== Description: =================================================================
JayDeBeApi - bridge from JDBC database drivers to Python DB-API JayDeBeApi - bridge from JDBC database drivers to Python DB-API
===================================================================== =================================================================
The JayDeBeApi module allows you to connect from Python code to The JayDeBeApi module allows you to connect from Python code to
databases using Java `JDBC databases using Java `JDBC
@ -33,7 +33,7 @@ Description: ===================================================================
You can get and install JayDeBeApi with `easy_install You can get and install JayDeBeApi with `easy_install
<http://peak.telecommunity.com/DevCenter/EasyInstall>`_ :: <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ ::
$ easy_install JayDeBeApi $ easy_install JayDeBeApi
If you want to install JayDeBeApi in Jython make sure to have If you want to install JayDeBeApi in Jython make sure to have
EasyInstall available for it. EasyInstall available for it.
@ -41,15 +41,15 @@ Description: ===================================================================
Or you can get a copy of the source branch using `bzr Or you can get a copy of the source branch using `bzr
<http://bazaar.canonical.com/>`_ by running :: <http://bazaar.canonical.com/>`_ by running ::
$ bzr branch lp:jaydebeapi $ bzr branch lp:jaydebeapi
and install it with :: and install it with ::
$ python setup.py install $ python setup.py install
or if you are using Jython use :: or if you are using Jython use ::
$ jython setup.py install $ jython setup.py install
It has been tested with Jython 2.5.2. It has been tested with Jython 2.5.2.
@ -88,13 +88,14 @@ Description: ===================================================================
access the database driver's jar files. If I want to connect to a HSQL access the database driver's jar files. If I want to connect to a HSQL
in memory database on my Ubuntu machine I'm starting Python by running :: in memory database on my Ubuntu machine I'm starting Python by running ::
$ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python $ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python
Now I have to configure JPype Now I have to configure JPype
>>> import jpype >>> import jpype
>>> jar = '/path/to/my/driver/hsqldb.jar' >>> jar = r'/path/to/my/driver/hsqldb.jar'
>>> args='-Djava.class.path=%s' % jar >>> args='-Djava.class.path=%s' % jar
>>> jvm_path = jpype.getDefaultJVMPath()
>>> jpype.startJVM(jvm_path, args) >>> jpype.startJVM(jvm_path, args)
or in Jython I have to or in Jython I have to
@ -109,12 +110,35 @@ Description: ===================================================================
In theory every database with a suitable JDBC driver should work. It In theory every database with a suitable JDBC driver should work. It
is known to work with the following databases: is known to work with the following databases:
* `SQLite 3 <http://www.sqlite.org/>`_ using `SqliteJDBC +-----------------------------------------+------------------------------------------------+---------------+----------------------+
<http://www.zentus.com/sqlitejdbc/>`_ v056 |Database |JDBC driver |Supported |Remarks |
* `Hypersonic SQL (HSQLDB) <http://hsqldb.org/>`_ 1.8.1.3 +=========================================+================================================+===============+======================+
* `IBM DB2 <http://www.ibm.com/software/data/db2/>`_ for z/OS using |`SQLite |`SqliteJDBC |Good |Can't interpret |
JDBC type 4 drivers. |<http://www.sqlite.org/>`_ |<http://www.zentus.com/sqlitejdbc/>`_ v056 | |selected BLOBs |
|3 | | |correctly. |
+-----------------------------------------+------------------------------------------------+---------------+----------------------+
| |`Sqlite Java Wrapper |Medium |Weird type handling. |
| |<http://www.ch-werner.de/javasqlite/>`_ | | |
| |javasqlite-20110106-win32 | | |
+-----------------------------------------+------------------------------------------------+---------------+----------------------+
|`Hypersonic SQL (HSQLDB) |Builtin |Very Good |No BLOB support |
|<http://hsqldb.org/>`_ 1.8.1.3 | | |by database. |
| | | | |
+-----------------------------------------+------------------------------------------------+---------------+----------------------+
|`Hypersonic SQL (HSQLDB) |Builtin |Medium |Weird decimal |
|<http://hsqldb.org/>`_ 2 | | |type |
| | | |conversions. No |
| | | |BLOB support. |
+-----------------------------------------+------------------------------------------------+---------------+----------------------+
|`IBM DB2 |JDBC type 4 drivers from IBM (``db2jcc.jar``) |Medium. |Not thoroughly tested |
|<http://www.ibm.com/software/data/db2/>`_| | |but seems to work |
|for z/OS | | |without problems. |
+-----------------------------------------+------------------------------------------------+---------------+----------------------+
|Oracle 11g |Oracle Thin Driver |Medium |Not thooughly |
| | | |testst. No support for|
| | | |rading of timestamps |
| | | |yet. |
+-----------------------------------------+------------------------------------------------+---------------+----------------------+
Contributing Contributing
============ ============
@ -134,32 +158,36 @@ Description: ===================================================================
Changelog Changelog
========= =========
- trunk - 0.1.3
- Fixed DB-API_ violation: Use ``curs.execute('foo ?', (bar, baz))`` - Fixed DB-API_ violation: Use ``curs.execute('foo ?', (bar, baz))``
instead of ``curs.execute('foo ?', bar, baz)``. instead of ``curs.execute('foo ?', bar, baz)``.
- Free resources after ``executemany`` call.
- Improved type handling. Initial support for BLOB columns.
- 0.1.2 - 0.1.2
- ``easy_install JayDeBeApi`` should really work - ``easy_install JayDeBeApi`` should really work.
- 0.1.1 - 0.1.1
- Fixed bug #688290 "NULL values with converters error on fetch." - Fixed bug #688290 "NULL values with converters error on fetch".
- Fixed bug #684909 "Selecting ROWIDs errors out on fetch." - Fixed bug #684909 "Selecting ROWIDs errors out on fetch".
- 0.1 - 0.1
- Initial release - Initial release.
To do To do
===== =====
- Extract Java calls to seperate Java methods to increase performance. - Extract Java calls to seperate Java methods to increase performance.
- Check if https://code.launchpad.net/dbapi-compliance can help making - Check if https://code.launchpad.net/dbapi-compliance can help making
JayDeBeApi more DB-API complient. JayDeBeApi more DB-API complient.
- Test it on different databases and provide a flexible db specific - Test it on different databases and provide a flexible db specific
pluign mechanism. pluign mechanism.
- SQLAlchemy modules (seperate project) - SQLAlchemy modules (seperate project)
.. _DB-API: http://www.python.org/dev/peps/pep-0249/ .. _DB-API: http://www.python.org/dev/peps/pep-0249/