commit python-portend for openSUSE:Factory

Hello community, here is the log from the commit of package python-portend for openSUSE:Factory checked in at 2019-04-09 20:16:33 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/python-portend (Old) and /work/SRC/openSUSE:Factory/.python-portend.new.3908 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Package is "python-portend" Tue Apr 9 20:16:33 2019 rev:3 rq:691695 version:2.4 Changes: -------- --- /work/SRC/openSUSE:Factory/python-portend/python-portend.changes 2019-03-08 11:00:44.004547198 +0100 +++ /work/SRC/openSUSE:Factory/.python-portend.new.3908/python-portend.changes 2019-04-09 20:16:34.541577387 +0200 @@ -1,0 +2,7 @@ +Fri Apr 5 07:03:43 UTC 2019 - Tomáš Chvátal + +- Update to 2.4: + * find_available_local_port now relies on socket.getaddrinfo to + find a suitable address family. + +------------------------------------------------------------------- Old: ---- portend-2.3.tar.gz New: ---- portend-2.4.tar.gz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ python-portend.spec ++++++ --- /var/tmp/diff_new_pack.XoqhnG/_old 2019-04-09 20:16:35.369579386 +0200 +++ /var/tmp/diff_new_pack.XoqhnG/_new 2019-04-09 20:16:35.381579415 +0200 @@ -18,7 +18,7 @@ %{?!python_module:%define python_module() python-%{**} python3-%{**}} Name: python-portend -Version: 2.3 +Version: 2.4 Release: 0 Summary: TCP port monitoring utilities License: MIT ++++++ portend-2.3.tar.gz -> portend-2.4.tar.gz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/.flake8 new/portend-2.4/.flake8 --- old/portend-2.3/.flake8 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/.flake8 2019-04-04 21:45:13.000000000 +0200 @@ -2,5 +2,9 @@ ignore = # Allow tabs for indentation W191 + # Workaround for https://github.com/PyCQA/pycodestyle/issues/836 + E117 # W503 violates spec https://github.com/PyCQA/pycodestyle/issues/513 W503 + # W504 has issues https://github.com/OCA/maintainer-quality-tools/issues/545 + W504 diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/.travis.yml new/portend-2.4/.travis.yml --- old/portend-2.3/.travis.yml 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/.travis.yml 2019-04-04 21:45:13.000000000 +0200 @@ -1,10 +1,10 @@ -dist: trusty -sudo: false +dist: xenial language: python python: - 2.7 -- &latest_py3 3.6 +- 3.6 +- &latest_py3 3.7 jobs: fast_finish: true @@ -12,19 +12,13 @@ - stage: deploy if: tag IS present python: *latest_py3 - install: skip - script: skip - deploy: - provider: pypi - on: - tags: true - all_branches: true - user: jaraco - password: - secure: vdFaBpjDV3pL+wS+uBguSyrWzIMYI238bovE6TFeEbCeXkAFpoS+Po+HKw76dpcVN4eTRwOqYuw9kZ+4spnl1RmgeTEsT8VwJQQTkpRmQ6KzikTMXya2KI3wFuKpB1x7ZFVaLasxtZ4+MULwgH5tE31YDulLWKPIJ6mn5sYcL0d3BbbKS7QPalF3KhJatWHEXjpj7j0XzW9wkjmeY1cmaVj+YQxNk5wMJQtFnrzS6Q0VI3ju+2RSRQUjXvnTPkK9bR0HUAJQOG9BWfNjcSGkPLvSp5BqAUiER8WYP7EAxjy51GHJZnXl95LGd1i9rJX3S3fN/e7QrYcGsmXA/jNK9qJ3C+QBhF70DqgZn2m9t8bmTWIQexV2DLNTZydU6VfrLvXUUiudXmQV6wk5/yhiR9jAKY2cJAsbTZ8wtsjAqQybEJBDZGyMRiUhTpUXBxYI9v5kpdvPVNe/gmGRCjwMmzwvwdcVBGSkVqfWoijvIRiE5+5fqEn2WnfLc8r4aFIvf0kusS1ZgSy9tt9UKQIPPNt9s12BfKx/vobDrEbFLZvDR6Cxyucq4znR12LWijosZINWVwSOpTXfgGJpFbDHwWzI8Z7/xfeSYoWjg8XJl2yeiXG+jCKKvYjpOU3e2Pw5d+MvhIyJJnRFBb7+kDyZktGqECVsIUfWrrlkFXuVfAQ= - distributions: dists - skip_cleanup: true - skip_upload_docs: true + before_script: skip + env: + - TWINE_USERNAME=jaraco + # TWINE_PASSWORD + - secure: I9gYsaelJuAp9MzZCQnw5cVfaZxjNtf1MarEv94oh7tW73Y0i+VYVTa5r2NDqbX9r4W+rFxuSKKgcuKbOxk39DJL5Yy5EjTm0SkmIjdGQuxIiAseWbMKfnoIv14J6ebwnKN+fUIYum8G8UJD4uOUiDbjxhL/m7pUcNjtxP3NLxWyITk9XyTS+3pQDL2XB0/bNMEMgfXenHiW6H+u2piWTXxQfPV/JmdkU3upQ5bkkIXP3njyirif2e2kC974Zbs3ajxVQGpgqKZ/3dirzH834UhzTHzhY7KTSdMh2IVyZJG5rEnDDrry63G3zKbphtsg7z/7K5uu8Lnx/O+vh7FDQCIkfJ7oKXU6fBFTFlRvnOFRy43qBor7EbmJi5GEWKvFzz/7hahR667OdHdyiPn1CCtXUpAApZJS+SgOhHkMvpn+mY3u8L1e7cS+RbsJkbY94Gll1vcgn5JQAMVwdiOtyWi4xqOlu1OEPe12/yVGVPhUe/FlNRRw30JY6MT4bd2Y+vo3yW4Aur69QfIiRzND0aAG9z55WmzP+zw/R68jjxXO5O7pNUoxoxUSJ6ay+oTAOEc+WCP8dGzG32CUDabgcRJg0NJhQMF/aYb6pAleNvuCK+zVGUAEui7Vdc7A0IMJ3eGWjJ4hEao8PtkdmhVQJ6CuHlYhHle5mi1DTAFYOVU= + - TOX_TESTENV_PASSENV="TWINE_USERNAME TWINE_PASSWORD" + script: tox -e release cache: pip diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/CHANGES.rst new/portend-2.4/CHANGES.rst --- old/portend-2.3/CHANGES.rst 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/CHANGES.rst 2019-04-04 21:45:13.000000000 +0200 @@ -1,3 +1,10 @@ +2.4 +=== + +#6: ``find_available_local_port`` now relies on + ``socket.getaddrinfo`` to find a suitable address + family. + 2.3 === diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/PKG-INFO new/portend-2.4/PKG-INFO --- old/portend-2.3/PKG-INFO 2018-06-09 22:03:11.000000000 +0200 +++ new/portend-2.4/PKG-INFO 2019-04-04 21:45:34.000000000 +0200 @@ -1,7 +1,7 @@ Metadata-Version: 2.1 Name: portend -Version: 2.3 -Summary: TCP port monitoring utilities +Version: 2.4 +Summary: TCP port monitoring and discovery Home-page: https://github.com/jaraco/portend Author: Jason R. Coombs Author-email: jaraco@jaraco.com @@ -58,7 +58,7 @@ Portend additionally exposes the lower-level port checking functionality in the ``Checker`` class, which currently exposes only one public - method, ``assert_free``. + method, ``assert_free``:: portend.Checker().assert_free('localhost', 31923) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/README.rst new/portend-2.4/README.rst --- old/portend-2.3/README.rst 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/README.rst 2019-04-04 21:45:13.000000000 +0200 @@ -50,7 +50,7 @@ Portend additionally exposes the lower-level port checking functionality in the ``Checker`` class, which currently exposes only one public -method, ``assert_free``. +method, ``assert_free``:: portend.Checker().assert_free('localhost', 31923) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/docs/conf.py new/portend-2.4/docs/conf.py --- old/portend-2.3/docs/conf.py 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/docs/conf.py 2019-04-04 21:45:13.000000000 +0200 @@ -1,32 +1,26 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -extensions = [ - 'sphinx.ext.autodoc', - 'jaraco.packaging.sphinx', - 'rst.linker', -] +extensions = ["sphinx.ext.autodoc", "jaraco.packaging.sphinx", "rst.linker"] -master_doc = 'index' +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)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n', - with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n', - ), - dict( - pattern=r'PEP[- ](?P\d+)', - url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', - ), - ], - ), + "../CHANGES.rst": dict( + using=dict(GH="https://github.com"), + replace=[ + dict( + pattern=r"(Issue #|\B#)(?P<issue>\d+)", + url="{package_url}/issues/{issue}", + ), + dict( + pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", + with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", + ), + dict( + pattern=r"PEP[- ](?P\d+)", + url="https://www.python.org/dev/peps/pep-{pep_number:0>4}/", + ), + ], + ) } diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/portend.egg-info/PKG-INFO new/portend-2.4/portend.egg-info/PKG-INFO --- old/portend-2.3/portend.egg-info/PKG-INFO 2018-06-09 22:03:11.000000000 +0200 +++ new/portend-2.4/portend.egg-info/PKG-INFO 2019-04-04 21:45:33.000000000 +0200 @@ -1,7 +1,7 @@ Metadata-Version: 2.1 Name: portend -Version: 2.3 -Summary: TCP port monitoring utilities +Version: 2.4 +Summary: TCP port monitoring and discovery Home-page: https://github.com/jaraco/portend Author: Jason R. Coombs Author-email: jaraco@jaraco.com @@ -58,7 +58,7 @@ Portend additionally exposes the lower-level port checking functionality in the ``Checker`` class, which currently exposes only one public - method, ``assert_free``. + method, ``assert_free``:: portend.Checker().assert_free('localhost', 31923) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/portend.egg-info/SOURCES.txt new/portend-2.4/portend.egg-info/SOURCES.txt --- old/portend-2.3/portend.egg-info/SOURCES.txt 2018-06-09 22:03:11.000000000 +0200 +++ new/portend-2.4/portend.egg-info/SOURCES.txt 2019-04-04 21:45:33.000000000 +0200 @@ -10,6 +10,7 @@ pytest.ini setup.cfg setup.py +skeleton.md test_portend.py tox.ini docs/conf.py @@ -18,6 +19,5 @@ portend.egg-info/PKG-INFO portend.egg-info/SOURCES.txt portend.egg-info/dependency_links.txt -portend.egg-info/namespace_packages.txt portend.egg-info/requires.txt portend.egg-info/top_level.txt \ No newline at end of file diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/portend.egg-info/namespace_packages.txt new/portend-2.4/portend.egg-info/namespace_packages.txt --- old/portend-2.3/portend.egg-info/namespace_packages.txt 2018-06-09 22:03:11.000000000 +0200 +++ new/portend-2.4/portend.egg-info/namespace_packages.txt 1970-01-01 01:00:00.000000000 +0100 @@ -1 +0,0 @@ - diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/portend.egg-info/requires.txt new/portend-2.4/portend.egg-info/requires.txt --- old/portend-2.3/portend.egg-info/requires.txt 2018-06-09 22:03:11.000000000 +0200 +++ new/portend-2.4/portend.egg-info/requires.txt 2019-04-04 21:45:33.000000000 +0200 @@ -6,7 +6,6 @@ rst.linker>=1.9 [testing] -pytest>=3.5 -pytest-sugar>=0.9.1 -collective.checkdocs +pytest!=3.7.3,>=3.5 +pytest-checkdocs pytest-flake8 diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/portend.py new/portend-2.4/portend.py --- old/portend-2.3/portend.py 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/portend.py 2019-04-04 21:45:13.000000000 +0200 @@ -12,9 +12,13 @@ import sys import itertools import contextlib -import collections import platform +try: + from collections import abc +except ImportError: + import collections as abc + from tempora import timing @@ -57,7 +61,7 @@ >>> Checker().assert_free('::', free_port) """ - if port is None and isinstance(host, collections.Sequence): + if port is None and isinstance(host, abc.Sequence): host, port = host[:2] if platform.system() == 'Windows': host = client_host(host) @@ -163,8 +167,9 @@ >>> 0 < find_available_local_port() < 65536 True """ - sock = socket.socket(socket.AF_INET6, socket.SOCK_STREAM) - addr = '', 0 + infos = socket.getaddrinfo(None, 0, socket.AF_UNSPEC, socket.SOCK_STREAM) + family, proto, _, _, addr = next(iter(infos)) + sock = socket.socket(family, proto) sock.bind(addr) addr, port = sock.getsockname()[:2] sock.close() diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/pyproject.toml new/portend-2.4/pyproject.toml --- old/portend-2.3/pyproject.toml 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/pyproject.toml 2019-04-04 21:45:13.000000000 +0200 @@ -1,2 +1,3 @@ [build-system] -requires = ["setuptools", "wheel", "setuptools_scm>=1.15"] +requires = ["setuptools>=34.4", "wheel", "setuptools_scm>=1.15"] +build-backend = "setuptools.build_meta" diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/pytest.ini new/portend-2.4/pytest.ini --- old/portend-2.3/pytest.ini 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/pytest.ini 2019-04-04 21:45:13.000000000 +0200 @@ -1,4 +1,11 @@ [pytest] norecursedirs=dist build .tox .eggs -addopts=--doctest-modules --flake8 -v +addopts=--doctest-modules --flake8 doctest_optionflags=ALLOW_UNICODE ELLIPSIS IGNORE_EXCEPTION_DETAIL +filterwarnings= + ignore:Possible nested set::pycodestyle:113 + ignore:Using or importing the ABCs::flake8:410 + # workaround for https://sourceforge.net/p/docutils/bugs/348/ + ignore:'U' mode is deprecated::docutils.io + # workaround for https://gitlab.com/pycqa/flake8/issues/275 + ignore:You passed a bytestring as `filenames`.::flake8 diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/setup.cfg new/portend-2.4/setup.cfg --- old/portend-2.3/setup.cfg 2018-06-09 22:03:11.000000000 +0200 +++ new/portend-2.4/setup.cfg 2019-04-04 21:45:34.000000000 +0200 @@ -1,12 +1,40 @@ -[aliases] -release = dists upload -dists = clean --all sdist bdist_wheel - [bdist_wheel] universal = 1 [metadata] license_file = LICENSE +name = portend +author = Jason R. Coombs +author_email = jaraco@jaraco.com +description = TCP port monitoring and discovery +long_description = file:README.rst +url = https://github.com/jaraco/portend +classifiers = + Development Status :: 5 - Production/Stable + Intended Audience :: Developers + License :: OSI Approved :: MIT License + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3 + +[options] +py_modules = portend +include_package_data = true +python_requires = >=2.7 +install_requires = + tempora>=1.8 +setup_requires = setuptools_scm >= 1.15.0 + +[options.extras_require] +testing = + pytest >= 3.5, !=3.7.3 + pytest-checkdocs + pytest-flake8 +docs = + sphinx + jaraco.packaging >= 3.2 + rst.linker >= 1.9 + +[options.entry_points] [egg_info] tag_build = diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/setup.py new/portend-2.4/setup.py --- old/portend-2.3/setup.py 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/setup.py 2019-04-04 21:45:13.000000000 +0200 @@ -1,72 +1,6 @@ #!/usr/bin/env python -# Project skeleton maintained at https://github.com/jaraco/skeleton - -import io - import setuptools -with io.open('README.rst', encoding='utf-8') as readme: - long_description = readme.read() - -name = 'portend' -description = 'TCP port monitoring utilities' -nspkg_technique = 'native' -""" -Does this package use "native" namespace packages or -pkg_resources "managed" namespace packages? -""" - -params = dict( - name=name, - use_scm_version=True, - author="Jason R. Coombs", - author_email="jaraco@jaraco.com", - description=description or name, - long_description=long_description, - url="https://github.com/jaraco/" + name, - packages=setuptools.find_packages(), - include_package_data=True, - namespace_packages=( - name.split('.')[:-1] if nspkg_technique == 'managed' - else [] - ), - python_requires='>=2.7', - py_modules=['portend'], - install_requires=[ - 'tempora>=1.8', - ], - extras_require={ - 'testing': [ - # upstream - 'pytest>=3.5', - 'pytest-sugar>=0.9.1', - 'collective.checkdocs', - 'pytest-flake8', - - # local - ], - 'docs': [ - # upstream - 'sphinx', - 'jaraco.packaging>=3.2', - 'rst.linker>=1.9', - - # local - ], - }, - setup_requires=[ - 'setuptools_scm>=1.15.0', - ], - classifiers=[ - "Development Status :: 5 - Production/Stable", - "Intended Audience :: Developers", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 2.7", - "Programming Language :: Python :: 3", - ], - entry_points={ - }, -) -if __name__ == '__main__': - setuptools.setup(**params) +if __name__ == "__main__": + setuptools.setup(use_scm_version=True) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/skeleton.md new/portend-2.4/skeleton.md --- old/portend-2.3/skeleton.md 1970-01-01 01:00:00.000000000 +0100 +++ new/portend-2.4/skeleton.md 2019-04-04 21:45:13.000000000 +0200 @@ -0,0 +1,128 @@ +# Overview + +This project is merged with [skeleton](https://github.com/jaraco/skeleton). What is skeleton? It's the scaffolding of a Python project jaraco [introduced in his blog](https://blog.jaraco.com/a-project-skeleton-for-python-projects/). It seeks to provide a means to re-use techniques and inherit advances when managing projects for distribution. + +## An SCM Managed Approach + +While maintaining dozens of projects in PyPI, jaraco derives best practices for project distribution and publishes them in the [skeleton repo](https://github.com/jaraco/skeleton), a git repo capturing the evolution and culmination of these best practices. + +It's intended to be used by a new or existing project to adopt these practices and honed and proven techniques. Adopters are encouraged to use the project directly and maintain a small deviation from the technique, make their own fork for more substantial changes unique to their environment or preferences, or simply adopt the skeleton once and abandon it thereafter. + +The primary advantage to using an SCM for maintaining these techniques is that those tools help facilitate the merge between the template and its adopting projects. + +Another advantage to using an SCM-managed approach is that tools like GitHub recognize that a change in the skeleton is the _same change_ across all projects that merge with that skeleton. Without the ancestry, with a traditional copy/paste approach, a [commit like this](https://github.com/jaraco/skeleton/commit/12eed1326e1bc26ce256e7b3f8cd8d3a5b...) would produce notifications in the upstream project issue for each and every application, but because it's centralized, GitHub provides just the one notification when the change is added to the skeleton. + +# Usage + +## new projects + +To use skeleton for a new project, simply pull the skeleton into a new project: + +``` +$ git init my-new-project +$ cd my-new-project +$ git pull gh://jaraco/skeleton +``` + +Now customize the project to suit your individual project needs. + +## existing projects + +If you have an existing project, you can still incorporate the skeleton by merging it into the codebase. + +``` +$ git merge skeleton --allow-unrelated-histories +``` + +The `--allow-unrelated-histories` is necessary because the history from the skeleton was previously unrelated to the existing codebase. Resolve any merge conflicts and commit to the master, and now the project is based on the shared skeleton. + +## Updating + +Whenever a change is needed or desired for the general technique for packaging, it can be made in the skeleton project and then merged into each of the derived projects as needed, recommended before each release. As a result, features and best practices for packaging are centrally maintained and readily trickle into a whole suite of packages. This technique lowers the amount of tedious work necessary to create or maintain a project, and coupled with other techniques like continuous integration and deployment, lowers the cost of creating and maintaining refined Python projects to just a few, familiar git operations. + +Thereafter, the target project can make whatever customizations it deems relevant to the scaffolding. The project may even at some point decide that the divergence is too great to merit renewed merging with the original skeleton. This approach applies maximal guidance while creating minimal constraints. + +# Features + +The features/techniques employed by the skeleton include: + +- PEP 517/518 based build relying on setuptools as the build tool +- setuptools declarative configuration using setup.cfg +- tox for running tests +- A README.rst as reStructuredText with some popular badges, but with readthedocs and appveyor badges commented out +- A CHANGES.rst file intended for publishing release notes about the project. + +## Packaging Conventions + +A pyproject.toml is included to enable PEP 517 and PEP 518 compatibility and declares the requirements necessary to build the project on setuptools (a minimum version compatible with setup.cfg declarative config). + +The setup.cfg file implements the following features: + +- Assumes universal wheel for release +- Advertises the project's LICENSE file (MIT by default) +- Reads the README.rst file into the long description +- Some common Trove classifiers +- Includes all packages discovered in the repo +- Data files in the package are also included (not just Python files) +- Declares the required Python versions +- Declares install requirements (empty by default) +- Declares setup requirements for legacy environments +- Supplies two 'extras': + - testing: requirements for running tests + - docs: requirements for building docs + - these extras split the declaration into "upstream" (requirements as declared by the skeleton) and "local" (those specific to the local project); these markers help avoid merge conflicts +- Placeholder for defining entry points + +Additionally, the setup.py file declares `use_scm_version` which relies on [setuptools_scm](https://pypi.org/project/setuptools_scm) to do two things: + +- derive the project version from SCM tags +- ensure that all files committed to the repo are automatically included in releases + +## Running Tests + +The skeleton assumes the developer has [tox](https://pypi.org/project/tox) installed. The developer is expected to run `tox` to run tests on the current Python version using [pytest](https://pypi.org/project/pytest). + +Other environments (invoked with `tox -e {name}`) supplied include: + + - a `build-docs` environment to build the documentation + - a `release` environment to publish the package to PyPI + +A pytest.ini is included to define common options around running tests. In particular: + +- rely on default test discovery in the current directory +- avoid recursing into common directories not containing tests +- run doctests on modules and invoke flake8 tests +- in doctests, allow unicode literals and regular literals to match, allowing for doctests to run on Python 2 and 3. Also enable ELLIPSES, a default that would be undone by supplying the prior option. +- filters out known warnings caused by libraries/functionality included by the skeleton + +Relies a .flake8 file to correct some default behaviors: + +- allow tabs for indentation (legacy for jaraco projects) +- disable mutually incompatible rules W503 and W504. + +## Continuous Integration + +The project is pre-configured to run tests in [Travis-CI](https://travis-ci.org) (.travis.yml). Any new project must be enabled either through their web site or with the `travis enable` command. In addition to running tests, an additional deploy stage is configured to automatically release tagged commits. The username and password for PyPI must be configured for each project using the `travis` command and only after the travis project is created. As releases are cut with [twine](https://pypi.org/project/twine), the two values are supplied through the `TWINE_USERNAME` and `TWINE_PASSWORD`. To configure the latter as a secret, run the following command: + +``` +echo "TWINE_PASSWORD={password}" | travis encrypt +``` + +Or disable it in the CI definition and configure it through the web UI. + +Features include: +- test against Python 2 and 3 +- run on Ubuntu Xenial +- correct for broken IPv6 + +Also provided is a minimal template for running under Appveyor (Windows). + +## Building Documentation + +Documentation is automatically built by [Read the Docs](https://readthedocs.org) when the project is registered with it, by way of the .readthedocs.yml file. To test the docs build manually, a tox env may be invoked as `tox -e build-docs`. Both techniques rely on the dependencies declared in `setup.cfg/options.extras_require.docs`. + +In addition to building the sphinx docs scaffolded in `docs/`, the docs build a `history.html` file that first injects release dates and hyperlinks into the CHANGES.rst before incorporating it as history in the docs. + +## Cutting releases + +By default, tagged commits are released through the continuous integration deploy stage. diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/portend-2.3/tox.ini new/portend-2.4/tox.ini --- old/portend-2.3/tox.ini 2018-06-09 22:02:47.000000000 +0200 +++ new/portend-2.4/tox.ini 2019-04-04 21:45:13.000000000 +0200 @@ -5,11 +5,8 @@ [testenv] deps = setuptools>=31.0.1 - # workaround for yaml/pyyaml#126 - # git+https://github.com/yaml/pyyaml@master#egg=pyyaml;python_version=="3.7" commands = - py.test {posargs} - python setup.py checkdocs + pytest {posargs} usedevelop = True extras = testing @@ -20,3 +17,15 @@ changedir = docs commands = python -m sphinx . {toxinidir}/build/html + +[testenv:release] +skip_install = True +deps = + pep517>=0.5 + # workaround for https://github.com/pypa/twine/issues/423 + git+https://github.com/pypa/twine + path.py +commands = + python -c "import path; path.Path('dist').rmtree_p()" + python -m pep517.build . + python -m twine upload dist/*