Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1023 Bytes

installation.md

File metadata and controls

48 lines (30 loc) · 1023 Bytes

Installation

Project requirements

  • Python 3.6 or above is necessary, without any additional Python libraries.

Install OS-level dependencies

macOS

Install brew.

Install packages with brew.

$ brew install python

Ubuntu/Debian

Install packages with apt if you have it, otherwise apt-get can be used instead.

$ sudo apt update
$ sudo apt install python3

Clone repo

$ git clone [email protected]:MichaelCurrin/history-report.git
$ cd history-report

Configure

$ cd historyreport/etc
$ cp config.template.py configlocal.py

You can either use the defaults copied from the template, or customize your local config file. For example, you way wish to change the input or output filenames (limited to files in the var directory). Or add unwanted high-volume domains to the ignore list, so that the report will be shorter.

$ editor configlocal.py