summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 2cb8e615bb5f84233ed57d0f68e5136aaa1e7942 (plain) (blame)
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<!-- -*- mode: markdown; -*- -->

# combox

Encrypts files and scatters them across storage provided by
proprietary online file storage providers like Google Drive, Dropbox,
etc.

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

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

Criticism is welcome here.

# etymology

`combox` is a lazy contraction of the word "combo box". `combox` is
pronounced as "combo box".

# status

Core functionality is being written at the moment. See `TODO.org`.

# requirements

* setuptools v5.5.x
* virtualenv v1.9.x or later
* python v2.7.x

# dependencies

* argparse v1.2.x or later
* nose v1.3.x
* pycrypto v2.6.1
* simplejson v3.8.0
* pickledb v0.3
* PyYAML v3.x
* watchdog v0.8.2

# platform

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

# setting up the environment

Install `virtualenv` and python's `setuptools` packages.

From the same directory as this README file, do:

    $ virtualenv .

Activate the virtual environment:

    $ source bin/activate

Install dependencies by simply installing combox:

    $ python setup.py install

# running tests

    $ nosetests -s

# license

The source code of `combox` is licensed under the [GNU General Public
License version 3 or later][gpl]. See COPYING.

The `combox` logo (`graphics/logo/combox-logo.svg`) is under [Public Domain][pd].

[gpl]: https://gnu.org/licenses/gpl-3.0.txt
[pd]: https://creativecommons.org/publicdomain/zero/1.0/

# canonical repo

    $ git clone http://rsiddharth.ninth.su/git/cb.git

# contact

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