Merge with skeleton

.readthedocs.yml

@@ -0,0 +1,5 @@
+python:
+  version: 3
+  extra_requirements:
+    - docs
+  pip_install: true

.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: python
+python:
+- 2.7
+- 3.6
+install:
+- pip install tox "setuptools>=28.2"
+script:
+- tox
+branches:
+  except:
+  - skeleton
+deploy:
+  provider: pypi
+  server: https://upload.pypi.org/legacy/
+  on:
+    tags: true
+    all_branches: true
+    python: 3.6
+  user: jaraco
+  # supply password with `travis encrypt --add deploy.password`
+  distributions: dists
+  skip_upload_docs: true

README.rst

@@ -1,7 +1,13 @@
-.. -*- restructuredtext -*-
+.. image:: https://img.shields.io/pypi/v/Fuzzy.svg
+   :target: https://pypi.org/project/Fuzzy
+
+.. image:: https://img.shields.io/pypi/pyversions/Fuzzy.svg
+
+.. image:: https://img.shields.io/pypi/dm/Fuzzy.svg
+
+.. image:: https://img.shields.io/travis/yougov/fuzzy/master.svg
+   :target: http://travis-ci.org/yougov/fuzzy
 
-Fuzzy
-=====
 
 Fuzzy is a python library implementing common phonetic algorithms quickly.
 Typically this is in string similarity exercises, but they're pretty versatile.

appveyor.yml

@@ -0,0 +1,21 @@
+environment:
+
+  APPVEYOR: true
+
+  matrix:
+    - PYTHON: "C:\\Python36-x64"
+    - PYTHON: "C:\\Python27-x64"
+
+install:
+  # symlink python from a directory with a space
+  - "mklink /d \"C:\\Program Files\\Python\" %PYTHON%"
+  - "SET PYTHON=\"C:\\Program Files\\Python\""
+  - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
+
+build: off
+
+test_script:
+  - "python -m pip install tox"
+  - "tox"
+
+version: '{build}'

docs/conf.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'jaraco.packaging.sphinx',
+    'rst.linker',
+]
+
+master_doc = 'index'
+
+link_files = {
+	'../CHANGES.rst': dict(
+		using=dict(
+			GH='https://github.com',
+		),
+		replace=[
+			dict(
+				pattern=r'(Issue )?#(?P<issue>\d+)',
+				url='{package_url}/issues/{issue}',
+			),
+			dict(
+				pattern=r'^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n',
+				with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n',
+			),
+			dict(
+				pattern=r'PEP[- ](?P<pep_number>\d+)',
+				url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/',
+			),
+		],
+	),
+}

docs/history.rst

@@ -0,0 +1,8 @@
+:tocdepth: 2
+
+.. _changes:
+
+History
+*******
+
+.. include:: ../CHANGES (links).rst

docs/index.rst

@@ -0,0 +1,22 @@
+Welcome to skeleton documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 1
+
+   history
+
+
+.. automodule:: skeleton
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+norecursedirs=dist build .tox .eggs
+addopts=--doctest-modules
+doctest_optionflags=ALLOW_UNICODE ELLIPSIS

setup.cfg

@@ -0,0 +1,6 @@
+[aliases]
+release = dists upload
+dists = clean --all sdist bdist_wheel
+
+[wheel]
+universal = 1

setup.py

@@ -1,34 +1,65 @@
+#!/usr/bin/env python
+
+# Project skeleton maintained at https://github.com/jaraco/skeleton
+
+import io
+
 import setuptools
 
-ext_modules = [
-    setuptools.Extension('fuzzy', ['src/fuzzy.pyx', 'src/double_metaphone.c']),
-]
+with io.open('README.rst', encoding='utf-8') as readme:
+	long_description = readme.read()
+
+name = 'Fuzzy'
+description = 'Fast Python phonetic algorithms'
 
 params = dict(
-    name='Fuzzy',
-    use_scm_version=True,
-    ext_modules=ext_modules,
-    description="Fast Python phonetic algorithms",
-    maintainer="YouGov, Plc.",
-    maintainer_email="jaraco@jaraco.com",
-    url="https://github.com/yougov/fuzzy",
-    classifiers=[
-        'Development Status :: 4 - Beta',
-        'License :: OSI Approved :: MIT License',
-        'License :: OSI Approved :: Artistic License',
-        'Operating System :: POSIX',
-        'Programming Language :: Python :: 2.7',
-        'Topic :: Text Processing',
-        'Topic :: Text Processing :: General',
-        'Topic :: Text Processing :: Indexing',
-        'Topic :: Text Processing :: Linguistic',
-    ],
-    long_description=open('README.rst').read(),
-    setup_requires=[
-        'setuptools_scm',
-        'cython',
-    ],
+	name=name,
+	use_scm_version=True,
+	author="YouGov, Plc.",
+	author_email="jaraco@jaraco.com",
+	description=description or name,
+	long_description=long_description,
+	url="https://github.com/yougov/" + name,
+	ext_modules=[
+		setuptools.Extension(
+			'fuzzy',
+			[
+				'src/fuzzy.pyx',
+				'src/double_metaphone.c'
+			]
+		),
+	],
+	python_requires='>=2.7,<3',
+	install_requires=[
+	],
+	extras_require={
+		'testing': [
+			'pytest>=2.8',
+			'pytest-sugar',
+		],
+		'docs': [
+			'sphinx',
+			'jaraco.packaging>=3.2',
+			'rst.linker>=1.9',
+		],
+	},
+	setup_requires=[
+		'setuptools_scm>=1.15.0',
+		'cython',
+	],
+	classifiers=[
+		'Development Status :: 4 - Beta',
+		'License :: OSI Approved :: MIT License',
+		'License :: OSI Approved :: Artistic License',
+		'Operating System :: POSIX',
+		'Programming Language :: Python :: 2.7',
+		'Topic :: Text Processing',
+		'Topic :: Text Processing :: General',
+		'Topic :: Text Processing :: Indexing',
+		'Topic :: Text Processing :: Linguistic',
+	],
+	entry_points={
+	},
 )
-
 if __name__ == '__main__':
-    setuptools.setup(**params)
+	setuptools.setup(**params)

tox.ini

@@ -0,0 +1,7 @@
+[tox]
+minversion = 2.4
+
+[testenv]
+commands = py.test {posargs}
+usedevelop = True
+extras = testing