Refine package docstring markup.
[python-gajja.git] / README
blobf91bc22924289a91e3f1f920bf4e81666d35f676
1 Gajja: Fake objects for real tests
2 ##################################
4 The `gajja` library provides a system of Python `test double`_ classes
5 for specific system objects:
7 * `Filesystem entries`_
9 * `Subprocesses`_
11 ..  _test double: http://xunitpatterns.com/Test%20Double.html
13 The Korean word 가짜 (*gajja*; IPA ˈkaːt͡ɕ̤a) means “fake thing”.
16 ============
17 Test doubles
18 ============
20 Filesystem entries
21 ==================
24 Subprocesses
25 ============
29 =======
30 Copying
31 =======
33 Copyright © 2015–2016 Ben Finney <ben+python@benfinney.id.au>
35 This is free software: you may copy, modify, and/or distribute this work
36 under the terms of the GNU General Public License as published by the
37 Free Software Foundation; version 3 of that license or any later version.
38 No warranty expressed or implied. See the file ‘LICENSE.GPL-3’ for details.
42     This document is written using `reStructuredText`_ markup, and can
43     be rendered with `Docutils`_ to other formats.
45     ..  _Docutils: http://docutils.sourceforge.net/
46     ..  _reStructuredText: http://docutils.sourceforge.net/rst.html
49     Local variables:
50     coding: utf-8
51     mode: text
52     mode: rst
53     End:
54     vim: fileencoding=utf-8 filetype=rst :