summaryrefslogblamecommitdiffstats
path: root/README
blob: 8af5ae8e500ee4ad57173c823e58679e404d4a84 (plain) (tree) 
3315af2
















































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
















































                                                                      
<!-- -*- mode: markdown; -*- -->

# combox

Splits and encrypts files and scatters them to directories which slurp
files into surveillance nodes like Google Docs, Dropbox, etc.

The ideas for this program is based on [`combobox`][1].

[1]: https://bitbucket.org/bgsucodeloverslab/combobox

# status

Core functionility is being written at the moment.

# requirments

* Python v2.7
* PyYAML v3.x

# platform

At the moment `combox` is written and tested on a GNU/Linux based
operating system.

# running tests

All the tests are at `combox/tests`. To run a test file, do:

    $ cd combox
	$ python -m tests.test_name

For instance, to run `combox/tests/test_crypto.py`, do:

    $ cd combox
	$ python -m tests.test_crypto

The success of the tests must be manually verified, so please read the
test file before you run them.

# license

`combox` is licensed under the GNU General Public License version 3 or
later. See COPYING.

# contact

Siddharth Ravikumar <sravik@bgsu.edu> (`gpg id: 0x00B252AF`)
siddharth ravikumar snafu