combox

split and encrypted files between online file storage providers
git clone git://git.ricketyspace.net/combox.git
Log | Files | Refs

commit 8dbe7dea37e381b1578c679cd738914544ecb786
parent 8450be5570e0384e163068bac71ee008f13e71e0
Author: Siddharth Ravikumar <sravik@bgsu.edu>
Date:   Thu, 17 Sep 2015 20:51:17 -0400

updated README.md

Diffstat:
README.md | 81++++++++++++++++++++++++++++++++++++++++++++++++-------------------------------
1 file changed, 49 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md @@ -1,71 +1,88 @@ -<!-- -*- mode: markdown; -*- --> - # combox -Encrypts files and scatters them across storage provided by -proprietary online file storage providers like Google Drive, Dropbox, -etc. +Encrypts files and scatters them across storage provided by Google +Drive and Dropbox. 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 +# runs on + + - GNU/Linux + - OS X + +# using combox + +## on GNU/Linux + +Install `virtualenv` and python dev. package. + +On a Debian based distribution, do: + + # aptitude install virtualenv python-dev -Core functionality is being written at the moment. See `TODO.org`. +## on OS X -# requirements +First install [Hombrew][brew.sh]: -* setuptools v5.5.x -* virtualenv v1.9.x or later -* python v2.7.x + $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" -# dependencies +Then do: -* 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 + $ brew update + $ brew doctor -# platform +[brew.sh]: http://brew.sh/ -At the moment `combox` is written and tested on a GNU/Linux based -operating system. +Next, install python from Hombrew: -# setting up the environment + $ brew install python -Install `virtualenv` and python's `setuptools` packages. +This will also install `pip`. -From the same directory as this README file, do: +Lastly do: + $ pip install virtualenv + +## set up combox + +Get the latest copy of combox: + + $ git clone http://rsiddharth.ninth.su/git/cb.git combox + +Setup virtual environment: + + $ cd combox $ virtualenv . Activate the virtual environment: $ source bin/activate -Install dependencies by simply installing combox: +Install combox: $ python setup.py install -# running tests +Run combox: + + $ combox - $ nosetests -s +Always make sure that the virtual environment is activated before +running combox. To activate virtual environment, do: + + $ cd path/to/combox + $ source bin/activate # license -The source code of `combox` is licensed under the [GNU General Public -License version 3 or later][gpl]. See COPYING. +`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].