
                        Python API for idnkit
             -- internationalized domain name toolkit --
                             version 2.1
               Japan Registry Services Co., Ltd.(JPRS)


Table of contents of this file:

  1. Overview
  2. Components
  3. Build
  4. Sample programs
  5. Contact information


1. Overview

This package provides Python API for idnkit, working on Python version
2.4 and later.  Currently, it supports idnkit version 2 (2.0 and later
versions).

To use this API package, idnkit binary (at least libidnkitlite shared
library) is required.

The latest version of idnkit can be found at:

        http://jprs.co.jp/idn/

Also the latest version of Python API for idnkit can be found here.

If you'd like to generate HTML documents by yourself, also Doxygen
is required.  Doxygen can be found at:

	http://www.doxygen.org


2. Components

This package contains the idnkit module, the documents written in
Doxygen and sample programs.


3. Build

Go to the top directory of the source distribution where 'setup.py'
file resides.

Edit 'setup.py' file.  Set 'idnkit_include_dir' and 'idnkit_library_dir'
variables to appropriate values.

	# Directory where idnkit header files are installed.
	idnkit_include_dir = '/usr/local/include'

	# Directory where libidnkitlite resides.
	idnkit_library_dir = '/usr/local/lib'
	
Then, execute 'setup.py build_ext' to build the idnkit module.

        % python setup.py build_ext

Run 'setup.py install' using 'sudo'

	% sudo ./setup.py install

or try becoming root using 'su' and then run 'setup.py install'.

	% su
	# python setup.py install

Run 'test.py' to run test programs.

	% cd test
        % python test.py

Optionally, execute 'doxygen' command to generate HTML documents.

	% cd ..
	% doxygen


4. Sample programs

The following scripts are placed at the 'tools' sub-directory.  They
are sample programs of the idnkit module.

    idnconv.py
        Tiny 'idnconv' ('idnconv2' in idnkit version 2) command.
	It always works as if '-whole' option is specified.

    idncmp.py
        Tiny 'idncmp' command.

    idncheck.py
        Tiny 'idncheck' command.

Those sample programs do not support some options the native commands
have.  For more details about options, execute the sample programs with
'-help' option.


5. Contact information

The latest version and information about Python API for idnkit can be
found at:

	http://jprs.co.jp/idn/

Send bug reports and comments to

	idnkit-info@jprs.co.jp
