Deduplicating archiver with compression and authenticated encryption.

Jonas Borgström a887fa2065 Verify hash before decompressing with PlaintextKey vor 12 Jahren
darc a887fa2065 Verify hash before decompressing with PlaintextKey vor 12 Jahren
docs 0c1d6e8179 Fix usage.rst syntax vor 12 Jahren
scripts da3e7a7470 setup.py: switch from setuptools to pure distutils vor 13 Jahren
.gitignore 8a2f555c68 Packaging improvements vor 12 Jahren
.travis.yml 7dd937fb4e Remove attempts to enable user_xattr vor 12 Jahren
LICENSE f827b99ffe Improved documentation. vor 12 Jahren
MANIFEST.in 1cb5cff7aa Add MANIFEST.in vor 12 Jahren
README.rst f827b99ffe Improved documentation. vor 12 Jahren
setup.py f827b99ffe Improved documentation. vor 12 Jahren
tox.ini 701a940de7 Inline comments not supported in tox.ini vor 12 Jahren

README.rst

What is darc?
-------------
Darc is a Deduplicating ARChiver written in Python. The main goal of darc is
to provide an efficient and secure way to backup data. The data deduplication
technique used makes darc suitable for daily backups since only actual changes
are stored.

Easy to use
~~~~~~~~~~~
Initialze backup repository and create a backup archive::

$ darc init /usbdrive/my-backup.darc
$ darc create -v /usbdrive/my-backup.darc::documents ~/Documents

Main features
~~~~~~~~~~~~~
Space efficient storage
Variable block size deduplication is used to reduce the number of bytes
stored by detecting redundant data. Each file is split into a number of
variable length chunks and only chunks that have never been seen before are
compressed and added to the repository.

Optional data encryption
All data can be protected using 256-bit AES encryption and data integrity
and authenticity is verified using HMAC-SHA256.

Off-site backups
darc can store data on any remote host accessible over SSH as long as
darc is installed.

What do I need?
---------------
Darc requires Python 3.2 or above to work. Besides Python darc also requires
msgpack-python and sufficiently recent OpenSSL (>= 1.0.0).

How do I install it?
--------------------
::
$ python setup.py install

Where are the docs?
-------------------
Go to https://pythonhosted.org/darc/ for a prebuilt version of the docs. You
can also build them yourself form the docs folder.

Where are the tests?
--------------------
The tests are in the darc/testsuite package. To run the test suite use the
following command::

$ python -m darc.testsuite.run

Where can I get help?
---------------------
Send questions, comments, patches, etc. to jonas@borgstrom.se. Issues and
pull requests can also be created on https://github.com/jborg/darc