Metadata-Version: 2.1
Name: syncrypt
Version: 0.5.0
Summary: Syncrypt client
Home-page: https://github.com/syncrypt/client
Author: Syncrypt UG
Author-email: support@syncrypt.space
License: UNKNOWN
Description: # Syncrypt client
        
        [![Build status](https://travis-ci.org/syncrypt/client.svg?branch=master)](https://travis-ci.org/syncrypt/client)
        [![Build status](https://ci.appveyor.com/api/projects/status/9jjn4gadwlc802c7?svg=true)](https://ci.appveyor.com/project/Syncrypt/client)
        [![PyPI version](https://img.shields.io/pypi/v/syncrypt.svg)](https://pypi.python.org/pypi/syncrypt)
        [![PyPI status](https://img.shields.io/pypi/status/syncrypt.svg)](https://pypi.python.org/pypi/syncrypt)
        
        Syncrypt is a fully encrypted file storage service for groups and private
        backups. This is the client that you can use to store and retrieve files.
        The client will also do all encryption.
        
        The source code for this client is released under the GNU General Public License
        Version 3. For more information have a look at the `LICENSE` file in this
        directory. Additional information on the GNU GPLv3 can be found here:
        http://www.gnu.org/licenses/quick-guide-gplv3.html
        
        ## Installation
        
        Option 1: Install from PyPI (requires Python 3.5+)
        
            pip install syncrypt
        
        This requires the ``snappy-c`` library in order to build the
        [python-snappy](https://github.com/andrix/python-snappy) dependency. In Ubuntu,
        you can install it with the APT package ``libsnappy-dev``. In OS X, you can
        install it with ```brew install snappy```.
        
        Option 2: Download one of the packages on our [releases page](https://alpha.syncrypt.space/releases/).
        
        Option 3: Install latest development version from source:
        
            pip install git+https://github.com/syncrypt/client
        
        ## Let's get started
        
        The ``syncrypt`` executable is the command line interface for Syncrypt. You
        can login to syncrypt so that you won't have to enter your login for every
        command you issue.
        
            syncrypt login
        
        This will ask for the email and the password of your Syncrypt account. If you
        do not have an account yet, please [sign up](https://syncrypt.space/) for our
        closed alpha mailing list and we will send you an invite.
        
        You can now initialize an arbitary directory as a vault. Simply change into
        this directory using ``cd`` and call:
        
            syncrypt init
        
        After you've set up the directory, you can push all of its contents by typing:
        
            syncrypt push
        
        For an extensive description of syncrypt commands, please see the [client
        manual](docs/manual.md).
        
        ## Further Information
        
         * [Syncrypt Alpha Signup](https://syncrypt.space/)
         * [Syncrypt Encryption](docs/encryption.md)
         * [Syncrypt CLI Manual](docs/manual.md)
         * [Syncrypt Daemon](docs/daemon.md)
         * [A guide through the Syncrypt client source code](docs/source_guide.md)
        
        ## Tests
        
        Install test requirements:
        
            bin/pip install -e '.[test]'
        
        Run all tests:
        
            bin/py.test
        
        Currently there is no public syncrypt instance that you can run your test
        against, so you can limit the tests to those not requiring a test server
        instance:
        
            bin/py.test -m 'not requires_server'
        
        ## Develop
        
        Setup in virtualenv for development:
        
            virtualenv .
            bin/pip install -e '.[dev]'
        
        ## Deploy
        
        Make Syncrypt distribution package for the current platform:
        
            bin/pip install -e '.[dist]'
            bin/python setup.py dist
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: End Users/Desktop
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: System :: Archiving
Classifier: Programming Language :: Python :: 3
Provides-Extra: dist
Provides-Extra: uvloop
Provides-Extra: win
Provides-Extra: test
