zeph1rus / companies_house_relationship_grapher

A tool to graph the relationships of people and companies on companies house using GraphViz and the companies house API.

Companies House Relationship Grapher

A tool that graphs the relationships between companies and people using the Companies House API.

Example:

See the full rendered graph here: Rendered Graph

Installation

First install Graphviz:

This depends on your OS

• Ubuntu: sudo apt-get install graphviz
• MacOS: brew install graphviz
• Windows: Download the installer

Then install the Python dependencies in a venv or equivalent (google this if you don't know how):

pip install -r requirements.txt

Companies House API Key

You'll need a companies house api key. You can get this by registering an application with Companies House in their developer portal

See: https://developer.company-information.service.gov.uk/get-started

Usage

python ch_parser.py 
    -u URL  # The URL of the base officer you're looking at - e.g https://find-and-update.company-information.service.gov.uk/officers/zvMsdSrp3DBpbynbh7l5mg9MlPI/appointments
    -k APIKEY # a Companies House API key
    [-d DETECT] # Detect service companies with large numbers of links - 'true' or 'false' (default faulse)
    [-n NUMBER] # The number of links to detect a service company - default 250

Files will be in the /output directory