setup.py

# -*- coding: utf-8 -*-
#
# Copyright (c) 2016 Stephan Linz
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#

'''
A setuptools based setup module.

See:
    https://packaging.python.org/
    https://packaging.python.org/distributing/
    https://pythonhosted.org/setuptools/
    https://github.com/pypa/sampleproject
'''

# Common OS support
import os

# Always prefer setuptools over distutils
from setuptools import setup, find_packages, Command

# To expand distutil's clean command
from pkg_resources import safe_name, to_filename
from distutils.command.clean import clean as _clean
from distutils.dir_util import remove_tree
from distutils import log

# To use a consistent encoding
from codecs import open

# To enforce right Python version
from sys import version_info

# To use the module meta data (version, author, ...)
import publishing.withsphinx as pubwsphinx

_INSTALL_REQUIRES = [
    'Sphinx>=1.3.0,<=1.8.9999',
    'sphinx-argparse>=0.2.0,<=0.2.5',
    'sphinxcontrib-ansi @ '
    + 'https://bitbucket.org/rexut/sphinx-contrib/get/default.zip'
    + '#sha1=f7e2c65d31ad8be7c314cf4379c69101546eb2fb'
    + '&subdirectory=ansi'
    + '&egg=sphinxcontrib-ansi-0.6.dev0',
    'sphinxcontrib-autoprogram>=0.1.5,<=0.1.5',
    'sphinxcontrib-bibtex>=0.3.5,<=0.4.9999',
    'sphinxcontrib-blockdiag>=1.5.5,<=1.5.5',
    'sphinxcontrib-email @ '
    + 'https://bitbucket.org/rexut/sphinx-contrib/get/default.zip'
    + '#sha1=f7e2c65d31ad8be7c314cf4379c69101546eb2fb'
    + '&subdirectory=email'
    + '&egg=sphinxcontrib-email-0.2.dev0',
    'sphinxcontrib-inlinesyntaxhighlight>=0.2.0,<=0.2.0',
    'sphinxcontrib-programoutput>=0.8.0,<=0.13.9999',
    'sphinxcontrib-spelling>=2.3.0,<=4.2.0',  # needs >4.2 for Sphinx 2.0
    'sphinxcontrib-tikz>=0.4.2,<=0.4.6',
    'reportlab>=3.4.0,<=3.5.9999',
    'CommonMark>=0.5.6,<=0.8.9999',
]

_EXTRAS_REQUIRE_DEV = [
    'sphinxcontrib-traceables @ '
    + 'https://github.com/rexut/sphinxcontrib-traceables/archive/py2to3-devel.zip'
    + '#sha1=3084d8b356230723e0fa93758a7bbc9c9bd2f3c2'
    + '&subdirectory='
    + '&egg=sphinxcontrib-traceables-0.1.5.dev1',
    'sphinxcontrib-traceability @ '
    + 'https://github.com/ociu/sphinx-traceability-extension/archive/85db6f4.zip'
    + '#sha1=74f7fc32cfda699a39d25ef438fda338e0eccc8f'
    + '&subdirectory='
    + '&egg=sphinxcontrib-traceability-0.1.2.dev0',
    'sphinx-rtd-theme>=0.4.2,<=0.4.2',
    'check-manifest>=0.37.0,<=0.37.9999',
    'webob>=1.8.5,<=1.8.5',
    'wheel>=0.32.3,<=0.32.3',
]

_EXTRAS_REQUIRE_TEST = [
    'sphinx-testing>=1.0.0,<=1.0.0',
    'tox>=2.0.0,<=3.9.9999',
    'nose>=1.3.7,<=1.3.7',
    'mock>=2.0.0,<=2.0.0',
    'coverage>=4.5.0,<=4.5.9999',
    'coveralls>=1.5.0,<=1.5.9999',
    'flake8>=3.7.4,<=3.7.4',
]

_EXTRAS_REQUIRE = {
    'dev': _EXTRAS_REQUIRE_DEV,
    'test': _EXTRAS_REQUIRE_TEST,
}

# Check and respect diferent Python versions
if version_info < (2, 7):
    exit('Sorry, Python 2 older than 2.7 is not supported')
elif version_info >= (3, 0) and version_info <= (3, 3):
    exit('Sorry, Python 3 older than 3.4 is not supported')

# Get project path absolut
_HERE = os.path.abspath(os.path.dirname(__file__))

# Get the long description from the README file
with open(os.path.join(_HERE, 'README.rst'), encoding='utf-8') as f:
    _README = f.read()


class RemoveEggInfo(Command):
    description = "remove a distribution's .egg-info directory"
    user_options = [
        ('egg-base=', 'e', "directory containing .egg-info directories"
                           " (default: top of the source tree)")
    ]
    boolean_options = []

    def initialize_options(self):
        '''init options'''
        self.egg_name = None
        self.egg_base = None
        self.egg_info = None

    def finalize_options(self):
        '''finalize options'''
        self.egg_name = safe_name(self.distribution.get_name())
        self.set_undefined_options('egg_info',
                                   ('egg_base', 'egg_base'))

        if self.egg_base is None:
            dirs = self.distribution.package_dir
            self.egg_base = (dirs or {}).get('', os.curdir)

        self.ensure_dirname('egg_base')
        self.egg_info = to_filename(self.egg_name) + '.egg-info'
        if self.egg_base != os.curdir:
            self.egg_info = os.path.join(self.egg_base, self.egg_info)

    def run(self):
        '''runner'''
        if os.path.exists(self.egg_info):
            remove_tree(self.egg_info, dry_run=self.dry_run)
        else:
            log.warn("'%s' does not exist -- can't clean it",
                     self.egg_info)


class CleanDoc(Command):
    description = 'Clean Sphinx documentation'
    user_options = [
        ('build-dir=', None, 'Build directory')
    ]
    boolean_options = []

    def initialize_options(self):
        '''init options'''
        self.build_dir = None

    def finalize_options(self):
        '''finalize options'''
        self.set_undefined_options('build_sphinx',
                                   ('build_dir', 'build_dir'))

    def run(self):
        '''runner'''
        if os.path.exists(self.build_dir):
            remove_tree(self.build_dir, dry_run=self.dry_run)
        else:
            log.warn("'%s' does not exist -- can't clean it",
                     self.build_dir)


class Clean(_clean):
    description = _clean.description
    user_options = _clean.user_options + [
        ('pyc', 'f',
         "remove any .pyc files left around in the directory tree")
    ]
    boolean_options = _clean.boolean_options + ['pyc']

    def initialize_options(self):
        '''init options'''
        _clean.initialize_options(self)
        self.pyc = None

    def finalize_options(self):
        '''finalize options'''
        _clean.finalize_options(self)

    def remove_file(self, name, verbose=1, dry_run=0):
        '''remove file by name'''
        if verbose >= 1:
            log.info("removing '%s' (if it is a file)", name)
        if dry_run:
            return
        if os.path.isfile(name):
            os.remove(name)

    def run(self):
        '''runner'''
        _clean.run(self)

        if self.pyc:
            for package in find_packages():
                cwd = os.path.join(os.getcwd(), package)
                for root, dirs, files in os.walk(cwd, topdown=False):
                    if root.endswith('__pycache__') and os.path.exists(root):
                        remove_tree(root, dry_run=self.dry_run)
                    else:
                        for name in files:
                            if name.endswith('.pyc'):
                                self.remove_file(os.path.join(root, name),
                                                 dry_run=self.dry_run)


setup(
    name='publishing-withsphinx',

    # Versions should comply with PEP440.  For a discussion on single-sourcing
    # the version across setup.py and the project code, see
    # https://packaging.python.org/en/latest/single_source_version.html
    version=pubwsphinx.__version__,

    # Author details
    author=pubwsphinx.__author__,
    author_email=pubwsphinx.__author_email__,

    # Package descriptions
    description='Sphinx extension to help document publishing',
    long_description=_README,

    # The project's main homepage.
    url='https://github.com/lipro/publishing-withsphinx',
    download_url='http://pypi.python.org/pypi/publishing-withsphinx',

    # Choose your license
    license='MIT',

    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        'Development Status :: 3 - Alpha',

        # Pick your license as you wish (should match "license" above)
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',

        # Specify the Python versions you support here. In particular, ensure
        # that you indicate whether you support Python 2, Python 3 or both.
        'Programming Language :: Python',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',

        # Indicate who your project is intended for
        'Environment :: Console',
        'Environment :: Web Environment',
        'Framework :: Sphinx :: Extension',
        'Intended Audience :: Developers',
        'Topic :: Documentation',
        'Topic :: Documentation :: Sphinx',
        'Topic :: Utilities',
    ],

    # What does your project relate to?
    keywords=[
        'publishing',
        'sphinx',
    ],

    # Prevent ZIP archive creation
    zip_safe=False,

    # Sort in as "publishing" namespace package -- Python does not normally allow
    # the contents of a package to be retrieved from more than one location.
    # Namespace packages are a solution for this problem.
    # Details, see: https://pythonhosted.org/setuptools/
    # --> "Building and Distributing Packages with Setuptools"
    #     --> "Namespace Packages"
    namespace_packages=['publishing'],

    # This package should work on any platforms that will be supported by Python
    platforms='any',

    # You can just specify the packages manually here if your project is
    # simple. Or you can use find_packages().
    packages=find_packages(exclude=['docs', 'tests']),

    # Tells setuptools to look for a MANIFEST.in file and install all the
    # entries that match as package data
    include_package_data=True,

    # If there are data files included in your packages that need to be
    # installed, specify them here.  If using Python 2.6 or less, then these
    # have to be included in MANIFEST.in as well.
    # package_data={
    #     # Any package contains LICENSE, *.txt or *.rst files, include them:
    #     '': ['AUTHORS', 'LICENSE', 'README.rst', 'TODO', 'CHANGES'],
    #     # And include any *.svg files found in the 'publishing-withsphinx' package, too:
    #     # 'publishing-withsphinx': ['*.svg'],
    # },

    # List run-time dependencies here.  These will be installed by pip when
    # your project is installed. For an analysis of "install_requires" vs pip's
    # requirements files see:
    # https://packaging.python.org/en/latest/requirements.html
    install_requires=_INSTALL_REQUIRES,

    test_suite='nose.collector',
    tests_require=_EXTRAS_REQUIRE_TEST,

    # List additional groups of dependencies here (e.g. development
    # dependencies). You can install these using the following syntax,
    # for example:
    # $ pip install -e .[dev,test]
    extras_require=_EXTRAS_REQUIRE,

    # ... Other setup options
    cmdclass={
        'remove_egg_info': RemoveEggInfo,
        'clean_sphinx': CleanDoc,
        'clean': Clean,
    }
)