1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
|
"""A setuptools based setup module.
See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""
import re
import sys
from os import path
from codecs import open # To use a consistent encoding
from setuptools import setup # Always prefer setuptools over distutils
from setuptools.command.test import test as TestCommand
here = path.abspath(path.dirname(__file__))
name = 'sshtunnel'
description = 'Pure python SSH tunnels'
url = 'https://github.com/pahaz/sshtunnel'
ppa = 'https://pypi.python.org/packages/source/s/{0}/{0}-'.format(name)
# Get the long description from the README file
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()
with open(path.join(here, 'docs.rst'), encoding='utf-8') as f:
documentation = f.read()
with open(path.join(here, 'changelog.rst'), encoding='utf-8') as f:
changelog = f.read()
with open(path.join(here, name + '.py'), encoding='utf-8') as f:
data = f.read()
version = eval(re.search("__version__[ ]*=[ ]*([^\r\n]+)", data).group(1))
class Tox(TestCommand):
""" Integration with tox """
def finalize_options(self):
TestCommand.finalize_options(self)
self.test_args = ['--recreate', '-v']
self.test_suite = True
def run_tests(self):
# import here, otherwise eggs aren't loaded
import tox
errcode = tox.cmdline(self.test_args)
sys.exit(errcode)
setup(
name=name,
# 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=version,
description=description,
long_description='\n'.join((long_description, documentation, changelog)),
# The project's main homepage.
url=url,
download_url=ppa + version + '.zip', # noqa
# Author details
author='Pahaz Blinov',
author_email='pahaz.blinov@gmail.com',
# 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',
# Indicate who your project is intended for
'Intended Audience :: Developers',
'Topic :: Software Development :: Build Tools',
# Pick your license as you wish (should match "license" above)
'License :: OSI Approved :: MIT License',
# 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 :: 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',
],
platforms=['unix', 'macos', 'windows'],
# What does your project relate to?
keywords='ssh tunnel paramiko proxy tcp-forward',
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
# packages=find_packages(exclude=['contrib', 'docs', 'tests']),
# Alternatively, if you want to distribute just a my_module.py, uncomment
# this:
py_modules=["sshtunnel"],
# 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=[
'paramiko>=1.15.2',
],
# 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={
'dev': ['check-manifest'],
'test': [
'tox>=1.8.1',
],
'build_sphinx': [
'sphinx',
'sphinxcontrib-napoleon',
],
},
# 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={
'tests': ['testrsa.key'],
},
# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# pip to create the appropriate form of executable for the target platform.
entry_points={
'console_scripts': [
'sshtunnel=sshtunnel:_cli_main',
]
},
# Integrate tox with setuptools
cmdclass={'test': Tox},
)
|