Skip to main content

Learn about tracking technologies, market structure and data-sharing on the web

Project description



<img
alt="whotracks.me"
style="width: 200px"
src="https://raw.githubusercontent.com/cliqz-oss/whotracks.me/master/static/img/who-tracksme-logo.png">

Bringing Transparency to online tracking - built by Cliqz and Ghostery.

___

This repository contains:

* data on trackers and websites as shown on [whotracks.me](https://whotracks.me) (`./data`)
* database mapping tracker domains to companies (`./db`)
* code to render the [whotracks.me](https://whotracks.me) site


# Installation

Python 3.x is needed to build the site. We recommend creating a
[virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) (or
`pipenv`) to install the dependencies.

## From Pypi

```sh
$ pip install whotracksme
```

## From source

```sh
$ pip install -e .
```

That's all you need to get started!

# Using the data

To get started with the data, everything you need can be found in
`whotracksme.data`:

```python
from whotracksme.data import (
load_apps,
load_companies,
load_overview,
load_sites,
load_tracker_db,
)

print(load_apps())
```

For more examples of scripts, have a look in the [contrib](./contrib) folder!

# Building the site

Building the site requires a few extra dependencies, not installed by default to
not make the installation heavier than it needs to be. You will need to install
`whotracksme` this way:

```sh
$ pip install 'whotracksme[website]'
```

Or if you do it from source:
```sh
$ pip install -e '.[website]'
```

*Furthermore* you also need to [install sass](http://sass-lang.com/install).


Once this is done, you will have access to a `whotracksme` entry point that can
be used this way:

```sh
$ whotracksme website [serve]
```

The `serve` part is optional and can be used while making changes on the
website.

All generated artifacts can be found in the `_site/` folder.

## Tests

To run tests, you will need `pytest`, or simply install `whotacksme` with the
`test` extra:

```sh
$ pip install -e '.[test,website]'
$ pytest
```

# Contributing

We are happy to take contributions on:
* guest articles for our blog in the topics of tracking, privacy and security. Feel free to use the data in this repository if you need inspiration.
* Curating our database of tracker profiles.


# License

The content of this project itself is licensed under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/), and the underlying
source code used to generate and display that content is licensed under the [MIT license](https://github.com/cliqz-oss/whotracks.me/blob/master/LICENSE.md).

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for whotrackme, version 2017.11
Filename, size File type Python version Upload date Hashes
Filename, size whotrackme-2017.11.tar.gz (19.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page