<commit_before>Paper to Git ![Build Status](https://travis-ci.org/maxking/paper-to-git.svg?branch=master)
============

This project aims to sync documents between [Dropbox Paper][0] and any local Git
repository. Why? Because apart from all other features that paper has, it is
an excellent in-brownser markdown editor.

This is an effort to create and automate Paper->Github Pages workflow, where I
can create and publish my blog posts by writing them in dropbox paper and
automatically fetching it from there and publishing it Github.

_Current State_: This project is currently in its very initial stages and
nothing is guaranteed to work. I will update this as the project moves forward.

Scripts:
========
These are a few test/example scripts that I have written to check/demonstrate
the usage of this project.

- `paper-sync.py`: sync all the documents to a local directory.

  ```bash
  $ python paper-sync.py DROPBOX_API_TOKEN path/to/data/directory/
  ```

License:
========

This project is licensed under MIT License. Please see the LICENSE file for a
complete copy of license.

_Note_: This project depends on a version of dropbox-python-sdk that is not yet
released. You will have to build a new copy of it's sdk if you want to run this
project and then install the library from source. [Here][1] you can find how to
do that. I would recommend running this inside a [virtualenv][2]


[0]: https://paper.dropbox.com
[1]: https://github.com/dropbox/dropbox-sdk-python#updating-api-specification
[2]: https://github.com/pypa/virtualenv
<commit_msg>Update project readme.<commit_after>Paper to Git ![Build Status](https://travis-ci.org/maxking/paper-to-git.svg?branch=master)
============

This project aims to sync documents between [Dropbox Paper][0] and any local Git
repository. Why? Because apart from all other features that paper has, it is
an excellent in-brownser markdown editor.

This is an effort to create and automate Paper->Github Pages workflow, where I
can create and publish my blog posts by writing them in dropbox paper and
automatically fetching it from there and publishing it in Github Pages.

_Current State_: This project is currently in its very initial stages and
nothing is guaranteed to work. I will update this as the project moves forward.

Install
=======
To install, try out the following commands:

```bash
$ virtualenv dropbox-sdk --python=python3
$ source dropbox-sdk/bin/activate
$ python setup.py install
```

Usage
=====

You can run `paper_git --help` in the console to print out the following help
text:

```
$ paper_git --help
usage: paper_git [-h] {shell,update} ...

        The Paper-to-Git system
        Copyright 2017 <NAME>

optional arguments:
  -h, --help      show this help message and exit

Commands:
  {shell,update}
    shell         Start an interactive paper git shell.
    update        Pull the list of Paper docs and update the database.
```

License:
========

This project is licensed under MIT License. Please see the LICENSE file for a
complete copy of license.


[0]: https://paper.dropbox.com
[1]: https://github.com/dropbox/dropbox-sdk-python#updating-api-specification
[2]: https://github.com/pypa/virtualenv

{'fraction_non_alphanumeric': 0.09350486350800126, 'fraction_numerical': 0.004706620646375902, 'mean_word_length': 4.108974358974359, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 6, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1478911', 'n_tokens_mistral': 904, 'n_tokens_neox': 868, 'n_words': 412}