Sugartrail

Sugartrail is a network analysis and visualisation tool easier and faster for researchers to explore connections between companies, persons and addresses within Companies House.

Requirements

You will require an API key from Companies House to authenticate with the API. First you will need to create a live application to get an API key which you can do by following the Companies House guide. You will then need to manually hard-code the API key inside the sugartrail.py script as the value for access_token.

Installation

1. Make sure you have Conda installed

2. Download the tool's repository using the command:

git clone https://github.com/ribenamaplesyrup/sugartrail.git

3. Navigate to the main directory and run:

conda env create -f environment.yml
conda activate candystore
jupyter nbextension enable --py --sys-prefix ipyleaflet
jupyter notebook

Usage