source: trunk/README.txt @ 26

Revision 26, 2.0 KB checked in by xi, 9 years ago (diff)

Add README.txt.

Line 
1
2============================================================
3PySyck: Python bindings for the Syck YAML parser and emitter
4============================================================
5
6:Author: Kirill Simonov
7:Contact: xi@resolvent.net
8:Web site: http://xitology.org/pysyck/
9
10.. contents::
11
12Overview
13========
14
15YAML_ is a data serialization format designed for human readability and
16interaction with scripting languages.
17
18Syck_ is an extension for reading and writing YAML in scripting languages. Syck
19provides bindings to the Python_ programming language, but they are somewhat
20limited and leak memory.
21
22PySyck_ is aimed to update the current Python bindings for Syck. The new
23bindings will provide wrappers for the Syck emitter and give access to the bare
24Parser tree. Hopefully it will not leak memory as well.
25
26.. _YAML: http://yaml.org/
27.. _Syck: http://whytheluckystiff.net/syck/
28.. _Python: http://python.org/
29.. _PySyck: http://xitology.org/pysyck/
30
31Requirements
32============
33
34PySyck requires Syck 0.55 or higher and Python 2.3 or higher. Python 2.2 is
35supported to some extent.
36
37Installation
38============
39
40PySyck requires Syck version 0.55 or higher. If you install it from source, unpack
41the source tarball and type::
42
43    $ python setup.py install
44
45Windows binaries for Python 2.2, 2.3, and 2.4 are provided.
46
47Usage
48=====
49
50FIXME: Documentation is always needed, but also hard to write...
51
52Development and Bug Reports
53===========================
54
55You may check out the PySyck_ source code from `PySyck SVN repository`_.
56
57If you find a bug in PySyck_, please file a bug report to `PySyck BTS`_. You
58may review open bugs on `the list of active tickets`_.
59
60.. _PySyck SVN repository: http://svn.xitology.org/pysyck/
61.. _PySyck BTS: http://trac.xitology.org/pysyck/newticket
62.. _the list of active tickets: http://trac.xitology.org/pysyck/report/1
63
64Author and Copyright
65====================
66
67The PySyck_ module was written by `Kirill Simonov`_.
68
69PySyck_ is released under the BSD license as Syck_ itself.
70
71.. _Kirill Simonov: mailto:xi@resolvent.net
72
Note: See TracBrowser for help on using the repository browser.