setup.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import os
import pathlib

from setuptools import setup, find_packages
from setuptools.command.sdist import sdist


PKGNAME = "whotracksme"


LONG_DESCRIPTION = ""
with pathlib.Path("README.md").open(encoding='utf-8') as readme_file:
    LONG_DESCRIPTION = readme_file.read()


# List all resources under whotracksme/data/
assets = []
DATA_DIR = pathlib.Path("whotracksme/data")
for root, dirs, files in os.walk(DATA_DIR):
    assets.extend(
        pathlib.Path(root, f).relative_to(DATA_DIR).as_posix()
        for f in files
        if f.endswith(".csv") or f.endswith(".sql")
    )

# This allows us to inject a custom version into setuptools using the
# environment variable: WTM_VERSION. If it is not specified, a default value is
# used, but you will not be able to run sdist in this case.
DEFAULT_VERSION = "0.dev"
VERSION = os.environ.get("WTM_VERSION", DEFAULT_VERSION)


class SDistCheckVersion(sdist):
    """Custom sdist hook used to make sure we can only package whotracksme if
    correct version is specified in the environment."""

    def run(self):
        if VERSION == DEFAULT_VERSION:
            raise Exception(f"$WTM_VERSION was not specified in environment. Aborting.")

        # Only run `sdist` if we found a valid version in environment.
        sdist.run(self)


setup(
    name=PKGNAME,
    version=VERSION,
    description="Learn about tracking technologies, market structure and data-sharing on the web",
    long_description=LONG_DESCRIPTION,
    classifiers=[
        "Development Status :: 4 - Beta",
        "Environment :: Console",
        "Intended Audience :: Developers",
        "Intended Audience :: Information Technology",
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
        "Programming Language :: Python :: 3.7",
        "Topic :: Internet",
        "Topic :: Scientific/Engineering :: Information Analysis",
    ],
    keywords="tracking whotracksme whotracks.me who tracks",
    url="https://whotracks.me",
    author="Ghostery Gmbh",
    author_email="privacy@ghostery.com",
    license="MIT",
    packages=find_packages(
        exclude=["_site", "blog", "contrib", "data", "static", "templates", "tests"]
    ),
    install_requires=["docopt", "pandas", "requests"],
    extras_require={
        "dev": [
            "aiohttp",
            "boto3",
            "colour",
            "feedgen",
            "jinja2>=2.10.1",
            "markdown",
            "pytest",
            "sanic",
            "squarify",
            "twine",
            "watchdog",
            "libsass",
            "pyyaml>=4.2b1",
        ]
    },
    package_data={f"{PKGNAME}.data": assets},
    zip_safe=True,
    entry_points={"console_scripts": [f"{PKGNAME}={PKGNAME}.main:main"]},
    cmdclass={"sdist": SDistCheckVersion},
)