tPYTHON.md - tomb - the crypto undertaker
  HTML git clone git://parazyd.org/tomb.git
   DIR Log
   DIR Files
   DIR Refs
   DIR README
   DIR LICENSE
       ---
       tPYTHON.md (1717B)
       ---
            1 Tomber: a Python wrapper for Tomb
            2 =================================
            3 
            4 Found in [extras/tomber](/extras/tomber)
            5 
            6 Description
            7 -----------
            8 
            9 Tomber is a python wrapper for [Tomb](https://github.com/dyne/Tomb).
           10 It relies on Python's subprocess module for Tomb command execution.
           11 
           12 Please note that for future compatibility with Tomb, using subprocess
           13 execution of the tomb script is the recommended way to wrap its
           14 functionalities in other languages.
           15 
           16 Tomber is still under development. Any contributions are greatly
           17 welcomed here or on its original repository
           18 https://github.com/reiven/tomber
           19 
           20 
           21 Installation
           22 ----------
           23 
           24 First of all Tomb must be installed. Refer to [INSTALL](/INSTALL.md)
           25 
           26 Then Tomber can be installed from
           27 [PyPi](https://pypi.python.org/pypi) using
           28 [pip](https://pypi.python.org/pypi/pip).
           29 
           30 Enter the following command in a terminal:
           31 
           32         pip install tomber
           33 
           34 Alternatively you can install it from this source repository
           35 
           36 
           37 Example usage
           38 -------------
           39 ```python
           40 from tomber import *
           41 
           42 # dig a tomb of 20mb
           43 tdig('test.tomb',20)
           44 
           45 # forge a key
           46 tforge('test.key', 'this is the passphrase for the key')
           47 
           48 # lock the tomb
           49 tlock('test.tomb', 'test.key', 'this is the passphrase for the key')
           50 
           51 # open the tomb
           52 topen('test.tomb', 'test.key', 'this is the passphrase for the key', '/tmp/tomb')
           53 
           54 # close the tomb
           55 tclose('test')
           56 ```
           57 
           58 Running tests
           59 -------------
           60 
           61 Keep in mind that the included *test.py* file execute the
           62 `Tomb.slam()` command which will likely close any tombs, encrypted
           63 volumes, you may have open.
           64 
           65 
           66 License
           67 -------
           68 
           69 Tomber is Copyright (c) 2014 by Federico Cardoso <reiven@gmail.com>
           70 
           71 This package is distributed under BSD License.
           72 
           73 See [LICENSE](https://github.com/reiven/pynientos/blob/master/LICENSE)