|
1 | | -# Kaitai Struct: runtime library for Python |
| 1 | +Kaitai Struct: runtime library for Python |
| 2 | +=========================================== |
2 | 3 |
|
3 | 4 | This library implements Kaitai Struct API for Python. |
4 | 5 |
|
5 | | -[Kaitai Struct](http://kaitai.io) is a declarative language used for |
| 6 | +`Kaitai Struct <http://kaitai.io>`_ is a declarative language used for |
6 | 7 | describe various binary data structures, laid out in files or in memory: |
7 | 8 | i.e. binary file formats, network stream packet formats, etc. |
8 | 9 |
|
9 | | -It is similar to Python's [construct] and [Construct3], but it is |
| 10 | +It is similar to `Python's Construct 2.9 <http://construct.readthedocs.org/>`_ but it is |
10 | 11 | language-agnostic. The format description is done in YAML-based .ksy |
11 | 12 | format, which then can be compiled into a wide range of target languages. |
12 | 13 |
|
13 | | -[construct]: https://pypi.python.org/pypi/construct |
14 | | -[Construct3]: http://tomerfiliba.com/blog/Survey-of-Construct3/ |
15 | | - |
16 | 14 | Further reading: |
17 | 15 |
|
18 | | -* [About Kaitai Struct](http://kaitai.io/) |
19 | | -* [About API implemented in this library](http://doc.kaitai.io/stream_api.html) |
20 | | -* [Python-specific notes](http://doc.kaitai.io/lang_python.html) |
| 16 | +* `About Kaitai Struct <http://kaitai.io/>`_ |
| 17 | +* `About API implemented in this library <http://doc.kaitai.io/stream_api.html>`_ |
| 18 | +* `Python specific notes <http://doc.kaitai.io/lang_python.html>`_ |
21 | 19 |
|
22 | | -## Installing |
| 20 | +Installing |
| 21 | +------------------------------ |
23 | 22 |
|
24 | | -### Using `requirements.txt` |
| 23 | +Using `requirements.txt` |
| 24 | +------------------------------ |
25 | 25 |
|
26 | 26 | If you want to use Kaitai Struct runtime in your project and you use |
27 | 27 | `requirements.txt` to manage your dependencies, just add the following |
28 | 28 | line to it: |
29 | 29 |
|
30 | | -``` |
31 | | -kaitaistruct |
32 | | -``` |
| 30 | +:: |
| 31 | + |
| 32 | + kaitaistruct |
33 | 33 |
|
34 | 34 | and then run `pip install -r requirements.txt` to update all your |
35 | 35 | dependencies. |
36 | 36 |
|
37 | | -### Using `pip` directly |
| 37 | +Using `pip` directly |
| 38 | +------------------------------ |
38 | 39 |
|
39 | 40 | You can use |
40 | 41 |
|
41 | | -```shell |
42 | | -pip install kaitaistruct |
43 | | -``` |
| 42 | +:: |
| 43 | + |
| 44 | + pip install kaitaistruct |
44 | 45 |
|
45 | 46 | to install the package manually using `pip` Python package manager. |
46 | 47 |
|
47 | | -## Licensing |
| 48 | +Licensing |
| 49 | +------------------------------ |
48 | 50 |
|
49 | 51 | Copyright 2015-2017 Kaitai Project: MIT license |
50 | 52 |
|
|
0 commit comments