diff --git a/docs/about.md b/docs/about.md index ab521df..d3df87c 100644 --- a/docs/about.md +++ b/docs/about.md @@ -2,4 +2,12 @@ title: About --- -TBD +# About +## Local First +Ichnion is a project led by [Georepublic](https://georepublic.info/), [Tokyo University](https://shiba.iis.u-tokyo.ac.jp/) and [Code4Japan](https://www.code4japan.org/). Its purpose is to allow you to analyze your own data collected from services like Google Takeout, Facebook Export or Twitter Export, whitout uploading it to a 3rd party service. It ensures your data stays with you. + +## Personal data +Ichnion aims to make it easy for everyone to obtain, inspect, analyze and control their personal data. + +## Digital privacy +With Ichnion everyone can gain insight in the data that is stored about us, fostering transparency in a digital society. diff --git a/docs/quickstart.md b/docs/quickstart.md index 870a5ca..9cbcc8e 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,5 +1,65 @@ --- title: Quickstart + --- -TBD +# Quickstart +Excavator extracts and stores data from your personal data exports. + +## Installing Excavator +### Compiling from source +You need to have a [package manager](https://doc.rust-lang.org/cargo/appendix/glossary.html#package-manager) called [cargo](https://doc.rust-lang.org/cargo/) in your local. + +If you already have got `rustc` installed in your local, you also have `cargo` installed locally. + +And then you can install with this command. + +```sh +$ cargo install --git https://github.com/ichnion/excavator --branch develop +``` + +### Install from crates.io +You can also install from package registry. + +```sh +$ cargo install excavator +``` + +### Install from Homebrew +```sh +$ brew tap ichnion/tap +$ brew install excavator +``` + +## How to use Excavator +### Prerequisite +Currently, we support *part of* `Google Takeout` and `Facebook` data. + +You need to prepare the applicable data from [Google Takeout](https://takeout.google.com/settings/takeout) or [Facebook](https://www.facebook.com/help/972879969525875). + +Supported files are below. + +- Google Takout + - `MyActivity.json` + - `search-history.json` + - `watch-history.json` + - `Location History.json` + - `Saved Place.json` + - `Semantic Location History.json` + - `All the .json files from Google Fit "All Sessions".` + +- Facebook + - `device_location.json` + - `primary_location.json` + - `primary_public_location.json` + +### Basic usage +Below is the basic example to use excavator. Which will recusively find the applicable file from *directory* and extract the data. + +`$ excavator read TakeOut` + +Or you can specify the single file + +`$ excavator read Location History.json` + +Then it will store the data into database. diff --git a/docs/user/index.md b/docs/user/index.md index fcfc662..69efa9a 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -5,3 +5,5 @@ slug: "/user" --- To help you get a hold of your personal data, we developed a tool called Excavator. Excavator extracts, stores and visualizes your personal data exports. + +In this part, you will learn how to safely collect and analyze your own data locally. diff --git a/docs/user/takeout/facebook.md b/docs/user/takeout/facebook.md index c4dac15..9d0fa54 100644 --- a/docs/user/takeout/facebook.md +++ b/docs/user/takeout/facebook.md @@ -22,3 +22,10 @@ The following datasets of Google Takeout are currently supported by Ichnion: | Device Location | yes | | Primary Location | yes | | Primary Public Location | yes | +| Last location | ? | + +:::tip + +After downloading location data from Facebook, you may have empty files. If yes, you should check in your device's settings if Facebook is allowed to use your location. [To turn it on](https://www.facebook.com/help/275925085769221). + +::: diff --git a/docs/user/takeout/google.md b/docs/user/takeout/google.md index dc20a92..dadfb2d 100644 --- a/docs/user/takeout/google.md +++ b/docs/user/takeout/google.md @@ -32,7 +32,7 @@ The following datasets of Google Takeout are currently supported by Ichnion: | Currents Stream | ? | | Data Shared for Research | ? | | Drive | ? | -| Fit | ? | +| Fit | yes | | Google Account | ? | | Google Cloud Search | ? | | Google Help Communities | ? | @@ -71,3 +71,9 @@ The following datasets of Google Takeout are currently supported by Ichnion: | Tasks | ? | | Voice | ? | | YouTube and YouTube Music | ? | + +:::tip + +After downloading data from Google Takeout, you may have empty files. If yes, you should check in your Google account's settings if Google is allowed to collect your data. To check it : Click on your Google account > Manage your Google account > Data & personalization > turn on activity controls. + +::: diff --git a/docs/user/visualize/jupyter.md b/docs/user/visualize/jupyter.md index 7c61340..7788e8b 100644 --- a/docs/user/visualize/jupyter.md +++ b/docs/user/visualize/jupyter.md @@ -3,3 +3,10 @@ title: Jupyter Notebook --- Visualization empowers you to inspect your digital footprints including potential values and possible risks. And it enables you to understand what data is collected about us. + +# How to use Jupyter Notebook with Ichnion ? + +If you are not familiar with Jupyter Notebook, you can follow [this tutorial](https://www.dataquest.io/blog/jupyter-notebook-tutorial/), or look at [the other visualization](https://ichnion.github.io/website/docs/user/visualize/other). + +Otherwise, [download the Jupyter example](https://github.com/ichnion/jupyter-examples) we made and follow the same steps as in the google-location-history.ipynb file to visualize your data. + diff --git a/sidebars.js b/sidebars.js index 474379d..bfd38c5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,7 +1,7 @@ module.exports = { docs: { 'Ichnion': [ - 'overview', 'about', 'quickstart', 'join', + 'about', 'quickstart', 'join', ], 'User Guide': [ 'user/index', 'user/install',