From e690b031cc3c07b657dc235252a284d8023a38dc Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 9 Feb 2017 12:29:49 -0500 Subject: Set the origin date once and forget it. --- docs/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 7402c7a..bf6ae64 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,6 +4,7 @@ import os import sys import subprocess +import datetime if 'check_output' not in dir(subprocess): import subprocess32 as subprocess @@ -22,7 +23,10 @@ dist_info_cmd = [sys.executable, setup_script] + fields output_bytes = subprocess.check_output(dist_info_cmd, cwd=root) project, version, url, author = output_bytes.decode('utf-8').strip().split('\n') -copyright = '2016 ' + author +origin_date = datetime.date(2017,1,1) +today = datetime.date.today() + +copyright = '{origin_date.year}-{today.year} {author}'.format(**locals()) # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.1 From b728c5892b394392044b245cba43f46740efb851 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 12 Mar 2017 13:33:19 -0400 Subject: Add python_requires directive. --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index 157ecb2..892b6b3 100644 --- a/setup.py +++ b/setup.py @@ -23,6 +23,7 @@ params = dict( packages=setuptools.find_packages(), include_package_data=True, namespace_packages=name.split('.')[:-1], + python_requires='>=2.7', install_requires=[ ], extras_require={ -- cgit v1.2.1 From 59c37d70f1140bf18b9a48398cc4502ebce91b5e Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 29 Mar 2017 14:36:54 -0400 Subject: Don't bother with copyright year(s). Let the repository history track the changes and copyright years. YAGNI. --- docs/conf.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index bf6ae64..fc94797 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,10 +23,7 @@ dist_info_cmd = [sys.executable, setup_script] + fields output_bytes = subprocess.check_output(dist_info_cmd, cwd=root) project, version, url, author = output_bytes.decode('utf-8').strip().split('\n') -origin_date = datetime.date(2017,1,1) -today = datetime.date.today() - -copyright = '{origin_date.year}-{today.year} {author}'.format(**locals()) +copyright = author # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.1 From 049284c6c440217c4f686b61c0980b5e0100626b Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 29 Mar 2017 14:39:02 -0400 Subject: Include the project (for docstrings). Include Sphinx (for environments where it's not an implied provision). --- docs/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 442df9f..c11e755 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,3 @@ +. +sphinx rst.linker -- cgit v1.2.1 From b9bcd869482ea0ff636c8848896a94e24a6fbfca Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 29 Mar 2017 14:40:02 -0400 Subject: Include pytest-sugar for nicer test output. --- tests/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/requirements.txt b/tests/requirements.txt index ab48405..6d65b37 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -1,2 +1,3 @@ pytest >= 2.8 +pytest-sugar subprocess32; python_version=="2.6" -- cgit v1.2.1 From 908cf4ad0e27813933ada7cc9f16ebce9ac0c6cc Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 04:36:53 -0400 Subject: Rely on jaraco.packaging for loading the package metadata from the package for Sphinx. --- docs/conf.py | 27 ++------------------------- docs/requirements.txt | 3 ++- 2 files changed, 4 insertions(+), 26 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fc94797..0e11c82 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,46 +1,23 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -import os -import sys -import subprocess -import datetime - -if 'check_output' not in dir(subprocess): - import subprocess32 as subprocess - extensions = [ 'sphinx.ext.autodoc', + 'jaraco.packaging.sphinx', 'rst.linker', ] -# General information about the project. - -root = os.path.join(os.path.dirname(__file__), '..') -setup_script = os.path.join(root, 'setup.py') -fields = ['--name', '--version', '--url', '--author'] -dist_info_cmd = [sys.executable, setup_script] + fields -output_bytes = subprocess.check_output(dist_info_cmd, cwd=root) -project, version, url, author = output_bytes.decode('utf-8').strip().split('\n') - -copyright = author - -# The full version, including alpha/beta/rc tags. -release = version - master_doc = 'index' link_files = { '../CHANGES.rst': dict( using=dict( GH='https://github.com', - project=project, - url=url, ), replace=[ dict( pattern=r"(Issue )?#(?P\d+)", - url='{url}/issues/{issue}', + url='{package_url}/issues/{issue}', ), dict( pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", diff --git a/docs/requirements.txt b/docs/requirements.txt index c11e755..e7b6a74 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ . sphinx -rst.linker +jaraco.packaging>=3.2 +rst.linker>=1.9 -- cgit v1.2.1 From 689f700fcfcdfcdc7d027f204a9654b101ac9ecb Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 04:43:46 -0400 Subject: Use single-quotes to satisfy the style nazis. --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0e11c82..8bc8298 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,15 +16,15 @@ link_files = { ), replace=[ dict( - pattern=r"(Issue )?#(?P\d+)", + pattern=r'(Issue )?#(?P\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", + 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+)", + pattern=r'PEP[- ](?P\d+)', url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), ], -- cgit v1.2.1 From 23dae906a2563a2da30e0d67490fa009576f6439 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 20:41:18 -0400 Subject: The requirement is no longer needed for tests. --- tests/requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/requirements.txt b/tests/requirements.txt index 6d65b37..d9e0f33 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -1,3 +1,2 @@ pytest >= 2.8 pytest-sugar -subprocess32; python_version=="2.6" -- cgit v1.2.1 From fbe7cb7fa1c0f4e30f6ac6e886c49ab6491aa959 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 21 Apr 2017 12:21:45 -0400 Subject: Add readthedocs yml file --- .readthedocs.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..e83d731 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +requirements_file: docs/requirements.txt +python: + version: 3 -- cgit v1.2.1 From 243e44fdb797ae54a08eb02d924f88e775e74ba9 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 21 Apr 2017 12:31:54 -0400 Subject: Move requirements for docs and testing into extras --- .readthedocs.yml | 4 +++- docs/requirements.txt | 4 ---- setup.py | 9 +++++++++ tests/requirements.txt | 2 -- tox.ini | 4 +--- 5 files changed, 13 insertions(+), 10 deletions(-) delete mode 100644 docs/requirements.txt delete mode 100644 tests/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index e83d731..8ae4468 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,5 @@ -requirements_file: docs/requirements.txt python: version: 3 + extra_requirements: + - docs + pip_install: true diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index e7b6a74..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -. -sphinx -jaraco.packaging>=3.2 -rst.linker>=1.9 diff --git a/setup.py b/setup.py index 892b6b3..2bed3f7 100644 --- a/setup.py +++ b/setup.py @@ -27,6 +27,15 @@ params = dict( 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', diff --git a/tests/requirements.txt b/tests/requirements.txt deleted file mode 100644 index d9e0f33..0000000 --- a/tests/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -pytest >= 2.8 -pytest-sugar diff --git a/tox.ini b/tox.ini index d740130..8efcba6 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,4 @@ [testenv] -deps = - -rtests/requirements.txt - commands = py.test {posargs} usedevelop = True +extras = testing -- cgit v1.2.1 From 3383a3aceb435cef929c13dff3e54e46af01cf49 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 26 Apr 2017 10:29:35 -0400 Subject: Add appveyor script for CI testing on Windows. --- appveyor.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 appveyor.yml diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..e856af3 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,19 @@ +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" -- cgit v1.2.1 From 110cb56c59e99c5d0c630612f8593a7ef55ce732 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 28 Apr 2017 19:21:34 -0400 Subject: Require tox 2.4 or later; fixes #2. --- tox.ini | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tox.ini b/tox.ini index 8efcba6..1ae06ef 100644 --- a/tox.ini +++ b/tox.ini @@ -1,3 +1,6 @@ +[tox] +minversion = 2.4 + [testenv] commands = py.test {posargs} usedevelop = True -- cgit v1.2.1 From c84284022a198d560e685c5a687458a5be4c5fe6 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 12 May 2017 21:42:53 -0400 Subject: Remove namespace_packages declaration, no longer needed. --- setup.py | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.py b/setup.py index 2bed3f7..a7aeae1 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,6 @@ params = dict( url="https://github.com/jaraco/" + name, packages=setuptools.find_packages(), include_package_data=True, - namespace_packages=name.split('.')[:-1], python_requires='>=2.7', install_requires=[ ], -- cgit v1.2.1 From 31fb9d19ee7751ced7a0339268b2cd7b3ceb4701 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 4 Jun 2017 14:02:51 -0400 Subject: Use a simple build number rather than prefixing with '1.0.' --- appveyor.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/appveyor.yml b/appveyor.yml index e856af3..0a8ce5c 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -17,3 +17,5 @@ build: off test_script: - "python -m pip install tox" - "tox" + +version: '{build}' -- cgit v1.2.1 From 16d68a9fd19e6a726cc86fd1e3ec5f2d24788345 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 14 Aug 2017 08:14:57 -0400 Subject: Restore support for namespace package declaration, selected on a 'nspkg_technique' setting --- setup.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/setup.py b/setup.py index a7aeae1..72d901c 100644 --- a/setup.py +++ b/setup.py @@ -11,6 +11,11 @@ with io.open('README.rst', encoding='utf-8') as readme: name = 'skeleton' description = '' +nspkg_technique = 'native' +""" +Does this package use "native" namespace packages or +pkg_resources "managed" namespace packages? +""" params = dict( name=name, @@ -22,6 +27,10 @@ params = dict( 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', install_requires=[ ], -- cgit v1.2.1 From 250cb960021233160e78a6f2c2780cfc1c964b9c Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 26 Aug 2017 15:35:09 -0400 Subject: Inspired by pypa/setuptools#1059, use the preferred bdist_wheel heading. --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index e080324..b0c90cb 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,5 +2,5 @@ release = dists upload dists = clean --all sdist bdist_wheel -[wheel] +[bdist_wheel] universal = 1 -- cgit v1.2.1