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) (WTM)
* database mapping tracker domains to companies
* code to render the [whotracks.me](https://whotracks.me) site


# Installation

Python 3.6 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.

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


## 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.loader import DataSource

# available entities
DataSource().trackers
DataSource().companies
DataSource().sites
```

For 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` from the repository, because not all assets are packaged with
`whotracksme` released on pypi:

```sh
$ pip install -e '.[dev]'
```

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
`dev` extra:

```sh
$ pip install -e '.[dev]'
$ 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.
* Feature requests that are doable using the WTM database.
* Curating our database of tracker profiles. Open an issue if you spot anything odd.


# Right to Amend
Please read our [Guideline for 3rd parties](https://github.com/cliqz-oss/whotracks.me/blob/master/RIGHT_TO_AMEND.md)
wanting to suggest corrections to their data.


# 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


Download files

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

Source Distribution

whotracksme-2018.3.tar.gz (51.5 MB view hashes)

Uploaded source

Built Distribution

whotracksme-2018.3-py3-none-any.whl (51.9 MB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page