Skip to content

Commit 278d745

Browse files
committed
README converted into reST and updated
1 parent 325f66b commit 278d745

File tree

3 files changed

+27
-22
lines changed

3 files changed

+27
-22
lines changed

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
include README.md
1+
include README.rst

README.md renamed to README.rst

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,52 @@
1-
# Kaitai Struct: runtime library for Python
1+
Kaitai Struct: runtime library for Python
2+
===========================================
23

34
This library implements Kaitai Struct API for Python.
45

5-
[Kaitai Struct](http://kaitai.io) is a declarative language used for
6+
`Kaitai Struct <http://kaitai.io>`_ is a declarative language used for
67
describe various binary data structures, laid out in files or in memory:
78
i.e. binary file formats, network stream packet formats, etc.
89

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
1011
language-agnostic. The format description is done in YAML-based .ksy
1112
format, which then can be compiled into a wide range of target languages.
1213

13-
[construct]: https://pypi.python.org/pypi/construct
14-
[Construct3]: http://tomerfiliba.com/blog/Survey-of-Construct3/
15-
1614
Further reading:
1715

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>`_
2119

22-
## Installing
20+
Installing
21+
------------------------------
2322

24-
### Using `requirements.txt`
23+
Using `requirements.txt`
24+
------------------------------
2525

2626
If you want to use Kaitai Struct runtime in your project and you use
2727
`requirements.txt` to manage your dependencies, just add the following
2828
line to it:
2929

30-
```
31-
kaitaistruct
32-
```
30+
::
31+
32+
kaitaistruct
3333

3434
and then run `pip install -r requirements.txt` to update all your
3535
dependencies.
3636

37-
### Using `pip` directly
37+
Using `pip` directly
38+
------------------------------
3839

3940
You can use
4041

41-
```shell
42-
pip install kaitaistruct
43-
```
42+
::
43+
44+
pip install kaitaistruct
4445

4546
to install the package manually using `pip` Python package manager.
4647

47-
## Licensing
48+
Licensing
49+
------------------------------
4850

4951
Copyright 2015-2017 Kaitai Project: MIT license
5052

setup.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from io import open
33
from kaitaistruct import __version__
44

5-
with open('README.md', encoding='utf-8') as f:
5+
with open('README.rst', encoding='utf-8') as f:
66
long_description = f.read()
77

88
setup(
@@ -38,7 +38,10 @@
3838
'Programming Language :: Python :: 3.4',
3939
'Programming Language :: Python :: 3.5',
4040
'Programming Language :: Python :: 3.6',
41+
"Programming Language :: Python :: 3.7",
42+
"Programming Language :: Python :: Implementation :: CPython",
43+
"Programming Language :: Python :: Implementation :: PyPy",
4144
],
4245
keywords='kaitai,struct,ksy,declarative,data structure,data format,file format,packet format,binary,parser,parsing,unpack,development',
43-
py_modules=["kaitaistruct"]
46+
py_modules=["kaitaistruct"],
4447
)

0 commit comments

Comments
 (0)