python/pyasn1/README

   1
   2 ASN.1 library for Python
   3 ------------------------
   4
   5 This is an implementation of ASN.1 types and codecs in Python programming
   6 language. It has been first written to support particular protocol (SNMP)
   7 but then generalized to be suitable for a wide range of protocols
   8 based on ASN.1 specification.
   9
  10 FEATURES
  11 --------
  12
  13 * Generic implementation of ASN.1 types (X.208)
  14 * Fully standard compliant BER/CER/DER codecs
  15 * 100% Python, works with Python 2.4 up to Python 3.3 (beta 1)
  16 * MT-safe
  17
  18 MISFEATURES
  19 -----------
  20
  21 * No ASN.1 compiler (by-hand ASN.1 spec compilation into Python code required)
  22 * Codecs are not restartable
  23
  24 INSTALLATION
  25 ------------
  26
  27 The pyasn1 package uses setuptools/distutils for installation. Thus do
  28 either:
  29
  30 $ easy_install pyasn1
  31
  32 or
  33
  34 $ tar zxf pyasn1-0.1.3.tar.gz
  35 $ cd pyasn1-0.1.3
  36 $ python setup.py install
  37 $ cd test
  38 $ python suite.py   # run unit tests
  39
  40 OPERATION
  41 ---------
  42
  43 Perhaps a typical use would involve [by-hand] compilation of your ASN.1
  44 specification into pyasn1-backed Python code at your application.
  45
  46 For more information on pyasn1 APIs, please, refer to the
  47 doc/pyasn1-tutorial.html file in the distribution.
  48
  49 Also refer to example modules. Take a look at pyasn1-modules package -- maybe
  50 it already holds something useful to you.
  51
  52 AVAILABILITY
  53 ------------
  54
  55 The pyasn1 package is distributed under terms and conditions of BSD-style
  56 license. See LICENSE file in the distribution. Source code is freely
  57 available from:
  58
  59 http://pyasn1.sf.net
  60
  61
  62 FEEDBACK
  63 --------
  64
  65 Please, send your comments and fixes to mailing lists at project web site.
  66
  67 =-=-=
  68 mailto: ilya@glas.net