Allexio / fb-user-data-analyser

A tool that analyses data downloadable by a Facebook user and generates a report in a nice, readable format.
GNU General Public License v3.0
4 stars 0 forks source link


Logo

Facebook Data Analyser

A tool to analyse your Facebook data, because no one wants to do it manually!

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License

About The Project

Facebook Data Analyser Screenshot

This is a tool that analyses data downloadable by a Facebook user and generates a report in a nice, readable format.

Here's why:

This is where my tool comes in. It takes your downloaded Facebook data zip file and then generates a nice report in web dashboard format.

Built With

This project is built entirely in Python 3. Any version of Python 3 should do. The dashboard is built on top of a template provided for free by ArchitectUI.

Getting Started

Prerequisites

To use this tool, you need to download your facebook data from Facebook. This data needs to be downloaded in JSON format and needs to contain everything (quick reminder that my tool runs locally and of course does not upload your data at any time).

Creating your own Distributable

This is entirely optional, and is meant for developers, not users

  1. Clone the repo

  2. Move to the root directory of the project

  3. Install pyinstaller

    pip install pyinstaller
  4. Build the project with pyinstaller

    pyinstaller .\src\main.py --add-data ".\report_template\;.\report_template\"

Usage

With the executable

(Windows only)

See the prerequisites section if you haven't already.

  1. Download the latest release from github (the release section is located in the tab on the right)
  2. Extract the contents of the release zip file wherever you want.
  3. Go in the resulting folder
  4. Double click on fb_data_analyser.exe
  5. If Windows shows you a warning about the fact that you downloaded this from the internet, click show more and then run anyway.

With Python

If you want to launch the python project, you will need python 3.7+

The Python version of this project also requires the NudeNet pypi library.

pip install NudeNet
  1. Clone the rep
  2. Move to the root directory of the project
  3. Launch the project with Python

    python ./src/fb_data_analyser.py

! WARNING FOR MAC USERS !

The tool expects a zip file where the contents are directly at the top level of the zip file.

If the facebook data file you download was automatically unzipped, you will have to manually zip the file, by selecting all the contents of the folder.

To clarify, the tree should look like this:

my-facebook-data.zip
-> about_you
-> accounts_center
-> ads_and_businesses

and not like this:

my-facebook-data.zip
-> my-facebook-data
  -> about_you
  -> accounts_center
  -> ads_and_businesses

License

The Python code is Distributed under the GPL 3 License. See LICENSE for more information. The HTML/CSS template, ChartJS and Bootstrap are all distributed under the MIT license.

Acknowledgements