<commit_before>Foursquare Archiver
===================

Archive your Foursquare checkin data locally.

This is a Python script for saving the json data from Foursuare's `checkins`
resource https://developer.foursquare.com/docs/users/checkins .


Getting started
---------------

Install requirements:

    make install

Get yourself a Foursquare Oauth token. See https://developer.foursquare.com/docs/explore

Set the `FOURSQUARE_OAUTH_TOKEN` environment variable


Usage
-----

Run `main.py`. A `data` directory will be created if it does not already exist.

    /path/to/main.py

### With Docker

You can also run this via Docker with something like:

    docker run -e FOURSQUARE_OAUTH_TOKEN=<KEY> -v /tmp/data:/app/data:rw crccheck/foursquare-archiver --data=/app/data<commit_msg>Update documentation to make a little more sense<commit_after>Foursquare Archiver
===================

Archive your Foursquare checkin data locally.

This is a Python script for saving the json data from Foursuare's `checkins`
resource https://developer.foursquare.com/docs/users/checkins .


Getting started
---------------

In a virtualenv, install requirements:

    make install

Get yourself a Foursquare Oauth token. See https://developer.foursquare.com/docs/explore

Set the `FOURSQUARE_OAUTH_TOKEN` environment variable

    export FOURSQUARE_OAUTH_TOKEN=<KEY>


Usage
-----

Run `main.py`. A `data` directory will be created if it does not already exist.

    ./main.py

### With Docker

You can also run this via Docker with something like:

    docker run --rm -e FOURSQUARE_OAUTH_TOKEN=<KEY> -v /tmp/data:/app/data:rw crccheck/foursquare-archiver --data=/app/data
{'fraction_non_alphanumeric': 0.12236286919831224, 'fraction_numerical': 0.0, 'mean_word_length': 3.7701149425287355, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 4, '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': '5149054', 'n_tokens_mistral': 525, 'n_tokens_neox': 498, 'n_words': 168}