https://github.com/dogsheep/swarm-to-sqlite

Create a SQLite database containing your checkin history from Foursquare Swarm
https://github.com/dogsheep/swarm-to-sqlite

datasette datasette-io datasette-tool dogsheep foursquare foursquare-api sqlite swarm

Last synced: 3 months ago
JSON representation

Create a SQLite database containing your checkin history from Foursquare Swarm

• Host: GitHub
• URL: https://github.com/dogsheep/swarm-to-sqlite
• Owner: dogsheep
• License: apache-2.0
• Created: 2019-08-30T17:37:29.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-04-11T03:18:16.000Z (over 1 year ago)
• Last Synced: 2024-03-19T19:21:07.802Z (4 months ago)
• Topics: datasette, datasette-io, datasette-tool, dogsheep, foursquare, foursquare-api, sqlite, swarm
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 57
• Watchers: 6
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - swarm-to-sqlite

README

        
# swarm-to-sqlite

[![PyPI](https://img.shields.io/pypi/v/swarm-to-sqlite.svg)](https://pypi.org/project/swarm-to-sqlite/)

[![Changelog](https://img.shields.io/github/v/release/dogsheep/swarm-to-sqlite?include_prereleases&label=changelog)](https://github.com/dogsheep/swarm-to-sqlite/releases)

[![Tests](https://github.com/dogsheep/swarm-to-sqlite/workflows/Test/badge.svg)](https://github.com/dogsheep/swarm-to-sqlite/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/dogsheep/swarm-to-sqlite/blob/main/LICENSE)

Create a SQLite database containing your checkin history from Foursquare Swarm.

## How to install

    $ pip install swarm-to-sqlite

## Usage

You will need to first obtain a valid OAuth token for your Foursquare account. You can do so using this tool: https://your-foursquare-oauth-token.glitch.me/

Simplest usage is to simply provide the name of the database file you wish to write to. The tool will prompt you to paste in your token, and will then download your checkins and store them in the specified database file.

    $ swarm-to-sqlite checkins.db

    Please provide your Foursquare OAuth token:

    Importing 3699 checkins  [#########-----------------------] 27% 00:02:31

You can also pass the token as a command-line option:

    $ swarm-to-sqlite checkins.db --token=XXX

Or as an environment variable:

    $ export FOURSQUARE_TOKEN=XXX

    $ swarm-to-sqlite checkins.db

To retrieve just checkins within the past X hours, days or weeks, use the `--since=` option. For example, to pull only checkins that happened within the last 10 days use:

    $ swarm-to-sqlite checkins.db --token=XXX --since=10d

Use `2w` for two weeks, `10h` for ten hours, `3d` for three days.

In addition to saving the checkins to a database, you can also write them to a JSON file using the `--save` option:

    $ swarm-to-sqlite checkins.db --save=checkins.json

Having done this, you can re-import checkins directly from that file (rather than making API calls to fetch data from Foursquare) like this:

    $ swarm-to-sqlite checkins.db --load=checkins.json

## Using with Datasette

The SQLite database produced by this tool is designed to be browsed using [Datasette](https://datasette.io/).

You can install the [datasette-cluster-map](https://datasette.io/plugins/datasette-cluster-map) plugin to view your checkins on a map.