nikdoof/foursquare-feeds
1
0
Fork 0
mirror of https://github.com/nikdoof/foursquare-feeds.git synced 2025-12-13 12:22:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme about KML files

Browse Source 
For #3
This commit is contained in:
Phil Gyford
2019-09-22 16:22:28 +01:00
parent 63a8165b85
commit 894fcf0302
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,6 +1,11 @@
# Foursquare Feeds # Foursquare Feeds
A python script that will generate an iCal (`.ics`) feed of your checkins on [Foursquare][4sq]/[Swarm][swarm]. If you set it up to save this file to a publicly-visible location on a webserver, and run the script regularly, you can subscribe to the feed in your favourite calendar application. A python script that will generate iCal (`.ics`) or KML files of your checkins on [Foursquare][4sq]/[Swarm][swarm].
If you set it up to save the iCal file to a publicly-visible location on a webserver, and run the script regularly, you can subscribe to the feed in your favourite calendar application.
A KML file can be loaded into a mapping application (such as Google Earth or
Maps) to view the checkins on a map.
Foursquare [used to have such feeds][feeds] but they've stopped working for me. Foursquare [used to have such feeds][feeds] but they've stopped working for me.
[I wrote a bit about this.][blog] [I wrote a bit about this.][blog]
@@ -93,7 +98,7 @@ Enter this in your `config.ini`.
## Run the script ## Run the script
You're ready to go: Generate a `.ics` file:
$ ./generate_feeds.py $ ./generate_feeds.py
@@ -104,6 +109,9 @@ If the file is generated in a location on your website that's publicly-visible,
Note that the file might contain private checkins or information you don't want to be public. In which case, it's probably best to make the name of any such publicly-readable file very obscure. Note that the file might contain private checkins or information you don't want to be public. In which case, it's probably best to make the name of any such publicly-readable file very obscure.
To generate a `.kml` file, see the `kind` option below.
### Script options ### Script options
#### `--all` #### `--all`
@@ -118,6 +126,18 @@ Depending on how many checkins you have you might only want to run it with
`--all` the first time and, once that's imported into a calendar application, `--all` the first time and, once that's imported into a calendar application,
subsequently only fetch recent checkins. subsequently only fetch recent checkins.
### `-k` or `--kind`
By default the script generates an iCal `.ics` file. Or, use this option to
specify an `.ics` file or a `.kml` file:
```bash
$ ./generate_feeds.py -k ics
$ ./generate_feeds.py -k kml
$ ./generate_feeds.py --kind=ics
$ ./generate_feeds.py --kind=kml
```
#### `-v` or `--verbose` #### `-v` or `--verbose`
By default the script will only output text if something goes wrong. To get By default the script will only output text if something goes wrong. To get