1. Marcus von Appen
  2. python-utils

Commits

Marcus von Appen  committed 48fc073

- minor readme improvements.

  • Participants
  • Parent commits 7b6d1cc
  • Branches default

Comments (0)

Files changed (1)

File README.txt

View file
  • Ignore whitespace
 licensing restrictions. Please see *COPYING.txt* for further details.
 
 Packages
-========
+========    
+The following packages are currently available.
 
 test.util
 ---------
 hierarchy as it is, so that you put your unittest files into test/ and keep
 all the framework files in test/util. ::
 
-   awesomeproject/
-     setup.py
-     README
-     awesomepackage/
-       __init__.py
-       wow.py
-       test/
-         __init__.py
-         wow_test.py
-         util/
-           runtests.py
-           support.py
-           testrunner.py
-           testutils.py
+    awesomeproject/
+        setup.py
+        README
+        awesomepackage/
+            __init__.py
+            wow.py
+            test/
+                __init__.py
+                wow_test.py
+                util/
+                    runtests.py
+                    support.py
+                    testrunner.py
+                    testutils.py
 
 You just need to stick to a single naming rule for files, which have to
 end with ``_test.py``. This can be changed in the `gettestfiles()`
 function in the *runtests.py* file.
 
-The whole test suite can be executed with a simple module execution ::
+The whole test suite can be executed with a simple module execution: ::
 
-   python -m awesomepackage.test.util.runtests
+    python -m awesomepackage.test.util.runtests
 
 Modules
 =======
+The following modules are currently available.
 
 array
 -----
 ---
 A simple ctypes wrapper class for loading shared libraries.
 
-
 ebs
 ---
 A simple component-based framework.
 Let's assume your application features something like the following
 layout: ::
 
-   awesomeapplication/
-      Application.exe
-      resources/
-         button.png
-         info.dat
-         textcontent.zip
-            [textfile1.txt, textfile2.txt]
+    awesomeapplication/
+        Application.exe
+            resources/
+            button.png
+            info.dat
+            textcontent.zip
+                [textfile1.txt, textfile2.txt]
 
 Within Application.exe (which previously might have been application.py,
 compiled and packaged via py2exe or something similar), you can define
 the resource bundle like ::
 
-   apppath = os.path.dirname(os.path.abspath(__file__))
-   appresources = Resources(os.path.join(apppath, "resources"))
+    apppath = os.path.dirname(os.path.abspath(__file__))
+    appresources = Resources(os.path.join(apppath, "resources"))
 
 and access your data files like ::
 
-   button_image = appresources.get("button.png")
-   info_file = appresources.get("info.dat")
+    button_image = appresources.get("button.png")
+    info_file = appresources.get("info.dat")
 
-   # Get textfile1.txt from textcontent.zip
-   textfile1 = appresources.get("textfile1.txt")
+    # Get textfile1.txt from textcontent.zip
+    textfile1 = appresources.get("textfile1.txt")
+
+Easy, isn't it?