From ea30deb1f5518a81f86ffb02b9fa4e1120f74799 Mon Sep 17 00:00:00 2001 From: baztian Date: Tue, 25 Jan 2011 16:47:08 +0100 Subject: [PATCH] Notes on how to build a new release --- .bzrignore | 1 + MANIFEST.in | 2 +- README_development.html | 366 ++++++++++++++++++++++++++++ src/JayDeBeApi.egg-info/PKG-INFO | 326 ++++++++++++------------- src/JayDeBeApi.egg-info/SOURCES.txt | 1 + 5 files changed, 532 insertions(+), 164 deletions(-) create mode 100644 README_development.html diff --git a/.bzrignore b/.bzrignore index 4efdf51..9bab088 100644 --- a/.bzrignore +++ b/.bzrignore @@ -1,3 +1,4 @@ +./README*.html ./*.class ./build ./dist diff --git a/MANIFEST.in b/MANIFEST.in index a973e49..a294a9e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ recursive-include src/test *.py *.sql -include README* COPYING* ez_setup.py prune *~ +include README*.rst COPYING* ez_setup.py diff --git a/README_development.html b/README_development.html new file mode 100644 index 0000000..2c4d922 --- /dev/null +++ b/README_development.html @@ -0,0 +1,366 @@ + + + + + + +JayDeBeApi - Development notes + + + +
+

JayDeBeApi - Development notes

+ +

Some notes for development.

+
+

Contents

+ +
+
+

Build a new release

+
    +

  1. Sync the branch.

    +
    +$ bzr pull
+
    +
    2. +

  2. Do your changes.

    +
    3. +

  3. Add a changelog entry to README.rst.

    +
    4. +

  4. Increase version in setup.py.

    +
    5. +

  5. Run setuptools to ensure everything is working as expected.

    +
    +$ python setup.py sdist
+
    +
    6. +

  6. Commit your changes.

    +
    +$ bzr ci -m "my comment"
+
    +
    7. +

  7. Tag for the new version.

    +
    +$ bzr tag jaydebeapi-0.1.2
+
    +
    8. +

  8. Send changes to launchpad.

    +
    +$ bzr push
+
    +
    9. +

  9. Publish new release on PyPi.

    +
    +$ python setup.py sdist --formats=gztar upload
+
    +
    10. +
+
+
+ + diff --git a/src/JayDeBeApi.egg-info/PKG-INFO b/src/JayDeBeApi.egg-info/PKG-INFO index ae95612..d317f46 100644 --- a/src/JayDeBeApi.egg-info/PKG-INFO +++ b/src/JayDeBeApi.egg-info/PKG-INFO @@ -1,163 +1,163 @@ -Metadata-Version: 1.0 -Name: JayDeBeApi -Version: 0.1.2 -Summary: A bridge from JDBC database drivers to Python DB-API. -Home-page: https://launchpad.net/jaydebeapi -Author: Bastian Bowe -Author-email: bastian.bowe@gmail.com -License: GNU LGPL -Description: ===================================================================== - JayDeBeApi - bridge from JDBC database drivers to Python DB-API - ===================================================================== - - The JayDeBeApi module allows you to connect from Python code to - databases using Java `JDBC - `_. It provides a - Python DB-API_ v2.0 to that database. - - It works on ordinary Python (cPython) using the JPype_ Java - integration or on `Jython `_ to make use of - the Java JDBC driver. - - It has been tested with `Hypersonic SQL (HSQLDB) - `_ and `IBM DB2 - `_ for z/OS. - - In contrast to zxJDBC from the Jython project JayDeBeApi let's you - access a database with Jython AND Python with only minor code - modifications. JayDeBeApi's future goal is to provide a unique and - fast interface to different types of JDBC-Drivers through a flexible - plug-in mechanism. - - .. contents:: - - Install - ======= - - You can get and install JayDeBeApi with `easy_install - `_ :: - - $ easy_install JayDeBeApi - - If you want to install JayDeBeApi in Jython make sure to have - EasyInstall available for it. - - Or you can get a copy of the source branch using `bzr - `_ by running :: - - $ bzr branch lp:jaydebeapi - - and install it with :: - - $ python setup.py install - - or if you are using Jython use :: - - $ jython setup.py install - - It has been tested with Jython 2.5.2. - - If you are using cPython ensure that you have installed JPype_ - properly. It has been tested with JPype 0.5.4. - - Usage - ===== - - Basically you just import the ``jaydebeapi`` Python module and execute - the ``connect`` method. This gives you a DB-API_ conform connection to - the database. - - The first argument to ``connect`` is the name of the Java driver - class. The rest of the arguments are internally passed to the Java - ``DriverManager.getConnection`` method. See the Javadoc of - ``DriverManager`` class for details. - - Here is an example: - - >>> import jaydebeapi - >>> conn = jaydebeapi.connect('org.hsqldb.jdbcDriver', - ... 'jdbc:hsqldb:mem', 'SA', '') - >>> curs = conn.cursor() - >>> curs.execute('create table CUSTOMER' - ... '("CUST_ID" INTEGER not null,' - ... ' "NAME" VARCHAR not null,' - ... ' primary key ("CUST_ID"))' - ... ) - >>> curs.execute("insert into CUSTOMER values (1, 'John')") - >>> curs.execute("select * from CUSTOMER") - >>> curs.fetchall() - [(1, u'John')] - - You probably have to configure Jython or JPype to actually be able to - 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 :: - - $ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python - - Now I have to configure JPype - - >>> jar = '/path/to/my/driver/hsqldb.jar' - >>> args='-Djava.class.path=%s' % jar - >>> jpype.startJVM(jvm_path, args) - - or in Jython I have to - - >>> jar = '/path/to/my/driver/hsqldb.jar' - >>> import sys - >>> sys.path.append(jar) - - Contributing - ============ - - Please submit `bugs and patches - `_. All contributors will be - acknowledged. Thanks! - - License - ======= - - JayDeBeApi is released under the GNU Lesser General Public license - (LGPL). See the file ``COPYING`` and ``COPYING.LESSER`` in the - distribution for details. - - - Changelog - ========= - - - 0.1.2 - - - ``easy_install JayDeBeApi`` should really work - - - 0.1.1 - - - Fixed bug #688290 "NULL values with converters error on fetch." - - Fixed bug #684909 "Selecting ROWIDs errors out on fetch." - - - 0.1 - - - Initial release - - To do - ===== - - - Extract Java calls to seperate Java methods to increase performance. - - Check if https://code.launchpad.net/dbapi-compliance can help making - JayDeBeApi more DB-API complient. - - Test it on different databases and provide a flexible db specific - pluign mechanism. - - SQLAlchemy modules (seperate project) - - .. _DB-API: http://www.python.org/dev/peps/pep-0249/ - .. _JPype: http://jpype.sourceforge.net/ - -Keywords: db api java jdbc bridge connect sql jpype jython -Platform: UNKNOWN -Classifier: Development Status :: 3 - Alpha -Classifier: Intended Audience :: Developers -Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL) -Classifier: Programming Language :: Java -Classifier: Programming Language :: Python -Classifier: Programming Language :: Python :: 2 -Classifier: Topic :: Database -Classifier: Topic :: Software Development :: Libraries :: Java Libraries -Classifier: Topic :: Software Development :: Libraries :: Python Modules +Metadata-Version: 1.0 +Name: JayDeBeApi +Version: 0.1.2 +Summary: A bridge from JDBC database drivers to Python DB-API. +Home-page: https://launchpad.net/jaydebeapi +Author: Bastian Bowe +Author-email: bastian.bowe@gmail.com +License: GNU LGPL +Description: ===================================================================== + JayDeBeApi - bridge from JDBC database drivers to Python DB-API + ===================================================================== + + The JayDeBeApi module allows you to connect from Python code to + databases using Java `JDBC + `_. It provides a + Python DB-API_ v2.0 to that database. + + It works on ordinary Python (cPython) using the JPype_ Java + integration or on `Jython `_ to make use of + the Java JDBC driver. + + It has been tested with `Hypersonic SQL (HSQLDB) + `_ and `IBM DB2 + `_ for z/OS. + + In contrast to zxJDBC from the Jython project JayDeBeApi let's you + access a database with Jython AND Python with only minor code + modifications. JayDeBeApi's future goal is to provide a unique and + fast interface to different types of JDBC-Drivers through a flexible + plug-in mechanism. + + .. contents:: + + Install + ======= + + You can get and install JayDeBeApi with `easy_install + `_ :: + + $ easy_install JayDeBeApi + + If you want to install JayDeBeApi in Jython make sure to have + EasyInstall available for it. + + Or you can get a copy of the source branch using `bzr + `_ by running :: + + $ bzr branch lp:jaydebeapi + + and install it with :: + + $ python setup.py install + + or if you are using Jython use :: + + $ jython setup.py install + + It has been tested with Jython 2.5.2. + + If you are using cPython ensure that you have installed JPype_ + properly. It has been tested with JPype 0.5.4. + + Usage + ===== + + Basically you just import the ``jaydebeapi`` Python module and execute + the ``connect`` method. This gives you a DB-API_ conform connection to + the database. + + The first argument to ``connect`` is the name of the Java driver + class. The rest of the arguments are internally passed to the Java + ``DriverManager.getConnection`` method. See the Javadoc of + ``DriverManager`` class for details. + + Here is an example: + + >>> import jaydebeapi + >>> conn = jaydebeapi.connect('org.hsqldb.jdbcDriver', + ... 'jdbc:hsqldb:mem', 'SA', '') + >>> curs = conn.cursor() + >>> curs.execute('create table CUSTOMER' + ... '("CUST_ID" INTEGER not null,' + ... ' "NAME" VARCHAR not null,' + ... ' primary key ("CUST_ID"))' + ... ) + >>> curs.execute("insert into CUSTOMER values (1, 'John')") + >>> curs.execute("select * from CUSTOMER") + >>> curs.fetchall() + [(1, u'John')] + + You probably have to configure Jython or JPype to actually be able to + 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 :: + + $ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python + + Now I have to configure JPype + + >>> jar = '/path/to/my/driver/hsqldb.jar' + >>> args='-Djava.class.path=%s' % jar + >>> jpype.startJVM(jvm_path, args) + + or in Jython I have to + + >>> jar = '/path/to/my/driver/hsqldb.jar' + >>> import sys + >>> sys.path.append(jar) + + Contributing + ============ + + Please submit `bugs and patches + `_. All contributors will be + acknowledged. Thanks! + + License + ======= + + JayDeBeApi is released under the GNU Lesser General Public license + (LGPL). See the file ``COPYING`` and ``COPYING.LESSER`` in the + distribution for details. + + + Changelog + ========= + + - 0.1.2 + + - ``easy_install JayDeBeApi`` should really work + + - 0.1.1 + + - Fixed bug #688290 "NULL values with converters error on fetch." + - Fixed bug #684909 "Selecting ROWIDs errors out on fetch." + + - 0.1 + + - Initial release + + To do + ===== + + - Extract Java calls to seperate Java methods to increase performance. + - Check if https://code.launchpad.net/dbapi-compliance can help making + JayDeBeApi more DB-API complient. + - Test it on different databases and provide a flexible db specific + pluign mechanism. + - SQLAlchemy modules (seperate project) + + .. _DB-API: http://www.python.org/dev/peps/pep-0249/ + .. _JPype: http://jpype.sourceforge.net/ + +Keywords: db api java jdbc bridge connect sql jpype jython +Platform: UNKNOWN +Classifier: Development Status :: 3 - Alpha +Classifier: Intended Audience :: Developers +Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL) +Classifier: Programming Language :: Java +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 2 +Classifier: Topic :: Database +Classifier: Topic :: Software Development :: Libraries :: Java Libraries +Classifier: Topic :: Software Development :: Libraries :: Python Modules diff --git a/src/JayDeBeApi.egg-info/SOURCES.txt b/src/JayDeBeApi.egg-info/SOURCES.txt index afa501c..067fdbc 100644 --- a/src/JayDeBeApi.egg-info/SOURCES.txt +++ b/src/JayDeBeApi.egg-info/SOURCES.txt @@ -2,6 +2,7 @@ COPYING COPYING.LESSER MANIFEST.in README.rst +README_development.rst ez_setup.py setup.py src/JayDeBeApi.egg-info/PKG-INFO