Briq
/
jaydebeapi
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

master
baztian 2015-02-07 21:27:34 +01:00
parent 5a1b68f211
commit 491e415c22
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.rst
View File

@ -25,20 +25,17 @@ plug-in mechanism.
Install Install
======= =======
You can get and install JayDeBeApi with `easy_install You can get and install JayDeBeApi with `pip <http://pip.pypa.io/>`_
<http://peak.telecommunity.com/DevCenter/EasyInstall>`_ :: ::
$ easy_install JayDeBeApi $ pip 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 pip or
EasyInstall available for it. EasyInstall available for it.
Or you can get a copy of the source branch using `bzr Or you can get a copy of the source by cloning from the `JayDeBeApi
<http://bazaar.canonical.com/>`_ by running :: github project <https://github.com/baztian/jaydebeapi>`_ and install
with ::
$ bzr branch lp:jaydebeapi
and install it with ::
$ python setup.py install $ python setup.py install
@ -46,10 +43,11 @@ or if you are using Jython use ::
$ jython setup.py install $ jython setup.py install
It has been tested with Jython 2.5.3. It has been tested with Jython 2.5.3 an 2.7-b3.
If you are using cPython ensure that you have installed JPype_ If you are using cPython ensure that you have installed JPype_
properly. It has been tested with JPype 0.5.4. properly. It has been tested with JPype1 0.5.7. Older JPype
installations may cause problems.
Usage Usage
===== =====
@ -140,8 +138,8 @@ Contributing
============ ============
Please submit `bugs and patches Please submit `bugs and patches
<https://bugs.launchpad.net/jaydebeapi>`_. All contributors will be <https://github.com/baztian/jaydebeapi/issues>`_. All contributors
acknowledged. Thanks! will be acknowledged. Thanks!
License License
======= =======
@ -154,7 +152,15 @@ distribution for details.
Changelog Changelog
========= =========
- 0.1.4 - 0.1.5 - To be released
- Host project source code at github.
- Use Travis CI build matrix.
- Require JPype1.
- 0.1.4 - 2013-10-29
- More convenient way to setup Java classpath. *Important note* - More convenient way to setup Java classpath. *Important note*
check the changes to the ``connect`` method and adapt your code. check the changes to the ``connect`` method and adapt your code.
@ -165,7 +171,7 @@ Changelog
- Changed signature of ``.setoutputsize()`` to be DB-API compliant. - Changed signature of ``.setoutputsize()`` to be DB-API compliant.
- 0.1.3 - 0.1.3 - 2011-01-27
- 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)``.
@ -174,16 +180,16 @@ Changelog
- Improved type handling. Initial support for BLOB columns. - Improved type handling. Initial support for BLOB columns.
- 0.1.2 - 0.1.2 - 2011-01-25
- ``easy_install JayDeBeApi`` should really work. - ``easy_install JayDeBeApi`` should really work.
- 0.1.1 - 0.1.1 - 2010-12-12
- 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 - 2010-08-10
- Initial release. - Initial release.
@ -198,4 +204,4 @@ To do
- SQLAlchemy modules (separate project) - SQLAlchemy modules (separate project)
.. _DB-API: http://www.python.org/dev/peps/pep-0249/ .. _DB-API: http://www.python.org/dev/peps/pep-0249/
.. _JPype: http://jpype.sourceforge.net/ .. _JPype: https://pypi.python.org/pypi/JPype1/