nucypher/setup.py

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


"""
This file is part of nucypher.

nucypher is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

nucypher is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with nucypher.  If not, see <https://www.gnu.org/licenses/>.
"""

import os

import sys
from setuptools import setup, find_packages
from setuptools.command.develop import develop
from setuptools.command.install import install

from .scripts.installation.install_solc import download_solc_binary

#
# Metadata
#


PACKAGE_NAME = 'nucypher'
BASE_DIR = os.path.dirname(__file__)
PYPI_CLASSIFIERS = [
      "Development Status :: 3 - Alpha",
      "Intended Audience :: Developers",
      "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
      "Natural Language :: English",
      "Operating System :: OS Independent",
      "Programming Language :: Python",
      "Programming Language :: Python :: 3 :: Only",
      "Programming Language :: Python :: 3.6",
      "Programming Language :: Python :: 3.7",
      "Programming Language :: Python :: 3.8",
      "Topic :: Security"
]

ABOUT = dict()
with open(os.path.join(BASE_DIR, PACKAGE_NAME, "__about__.py")) as f:
    exec(f.read(), ABOUT)


#
# Utilities
#

class VerifyVersionCommand(install):
    """Custom command to verify that the git tag matches our version"""
    description = 'verify that the git tag matches our version'

    def run(self):
        tag = os.getenv('CIRCLE_TAG')
        if tag.startswith('v'):
            tag = tag[1:]

        version = ABOUT['__version__']
        if version.startswith('v'):
            version = version[1:]

        if tag != version:
            info = "Git tag: {0} does not match the version of this app: {1}".format(
                os.getenv('CIRCLE_TAG'), ABOUT['__version__']
            )
            sys.exit(info)


class PostDevelopCommand(develop):
    """
    Post-installation for development mode.
    Execute manually with python setup.py develop or automatically included with
    `pip install -e . -r dev-requirements.txt`
    """
    def run(self):
        develop.run(self)
        print("Downloading solidity compiler binary")
        download_solc_binary()


#
#  Dependencies
#

def read_requirements(path):
    with open(os.path.join(BASE_DIR, path)) as f:
        _PIPENV_FLAGS, *REQUIREMENTS = f.read().split('\n')
    return REQUIREMENTS


INSTALL_REQUIRES = read_requirements('requirements.txt')
DOCS_REQUIRE = read_requirements('docs-requirements.txt')
DEV_REQUIRES = read_requirements('dev-requirements.txt')

BENCHMARK_REQUIRES = [
    'pytest-benchmark'
]

DEPLOY_REQUIRES = [
    'bumpversion',
    'ansible'
]

EXTRAS = {
    'docs': DOCS_REQUIRE,
    'dev': DEV_REQUIRES + DOCS_REQUIRE,
    'benchmark': DEV_REQUIRES + BENCHMARK_REQUIRES
}


setup(

    # Requirements
    python_requires='>=3',
    setup_requires=['pytest-runner', 'setuptools-markdown'],
    install_requires=INSTALL_REQUIRES,
    extras_require=EXTRAS,

    # Package Data
    packages=find_packages(exclude=["tests"]),
    include_package_data=True,
    zip_safe=False,

    # Entry Points
    entry_points={'console_scripts': [
      f'{PACKAGE_NAME} = {PACKAGE_NAME}.cli.main:nucypher_cli',
      f'{PACKAGE_NAME}-deploy = {PACKAGE_NAME}.cli.commands.deploy:deploy',
    ]},

    # Utilities
    cmdclass={'verify': VerifyVersionCommand,
              'develop': PostDevelopCommand},

    # Metadata
    name=ABOUT['__title__'],
    url=ABOUT['__url__'],
    version=ABOUT['__version__'],
    author=ABOUT['__author__'],
    author_email=ABOUT['__email__'],
    description=ABOUT['__summary__'],
    license=ABOUT['__license__'],
    long_description_content_type="text/markdown",
    long_description_markdown_filename='README.md',
    keywords="nucypher, proxy re-encryption",
    classifiers=PYPI_CLASSIFIERS
)