diff --git a/.gitignore b/.gitignore index c4132da..8d9e69a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ dist/ *.sqlite MANIFEST -README.txt bin/ lib/ share/ diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..0e23b56 --- /dev/null +++ b/README.txt @@ -0,0 +1,99 @@ +JOTTALIB +======== + +|Join the chat at https://gitter.im/havardgulldahl/jottalib| +|Requirements Status| |Build status master branch| + +This is a rich, pythonic interface to the Jottacloud backup/cloud +storage service. The service itself exposes a nice and simple HTTP REST +api, and this library wraps that interface in a python module, in the +hope that it may be useful. + +This is a community project, not an official Jottacloud product. It is +developed `according to the company founder's +instructions `__, with +write support reverse engineered `explicitly blessed by company +staff `__. + +All code is GPLv3 licensed, and the `documentation is +online `__. + +In addition to the general library, you'll also find different backup +tools, some different plugins as well as a FUSE implementation in here. + +Caveats +------- + +This code has **alpha status**, it's **not production ready** and +**don't trust it with your data**! It might not eat your cat, but it +might mangle your cat photos! + +Write support is reverse engineered and not based on official docs. Bugs +patrol these waters! (When you find them, add to the `bug +tracker! `__ ) + +Installation +------------ + +Note that we've separated the code into two packages: + +- If you are a normal user, wanting to backup your stuff: get + ``jottacloudclient`` +- If you are a developer and want to add connectivity to JottaCloud.com + to your project, get ``jottalib`` + +Via pip +~~~~~~~ + +The easiest way: ``pip install jottacloudclient`` or +``pip install jottalib``. + +Optional requirements +~~~~~~~~~~~~~~~~~~~~~ + +These are extras you would install if you need it: + +- ``pip install jottacloudclient[FUSE]`` for a Fuse client (`read more + about + it `__) +- ``pip install jottacloudclient[monitor]`` for a tool to continuously + monitor a folder on your system (`read more about + it `__) +- ``pip install jottalib[Qt]`` for developers wanting to use the Qt + models (`help is on the + way `__) + +Documentation +------------- + +To help both end users and developers to get started, a lot of use cases +are `covered in the +wiki `__. + +Authors +------- + +The library was initiated by havard@gulldahl.no, but **a project like +this needs a lot of community love**. Luckily patches, suggestions and +comments are trickling in, take a look at `AUTHORS.md `__ +for the full picture. + +If you notice something wrong, need some new functionality or want to +participate, `let us know about +it! `__ + +We need coders, quality assurance and power users alike, so if you want +to lend a hand, don't hesitate to open a new issue. Your help will be +much appreciated! + +If you want to chat about a bug or ask a general question, you'll find +the core contributors `in the gitter.im +room `__. Come and take a +look! + +.. |Join the chat at https://gitter.im/havardgulldahl/jottalib| image:: https://badges.gitter.im/Join%20Chat.svg + :target: https://gitter.im/havardgulldahl/jottalib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +.. |Requirements Status| image:: https://requires.io/github/havardgulldahl/jottalib/requirements.svg?branch=master + :target: https://requires.io/github/havardgulldahl/jottalib/requirements/?branch=master +.. |Build status master branch| image:: https://travis-ci.org/havardgulldahl/jottalib.svg?branch=master + :target: https://travis-ci.org/havardgulldahl/jottalib.svg?branch=master