Hello community,
here is the log from the commit of package python-jaraco.packaging for
openSUSE:Leap:15.2 checked in at 2020-03-09 18:06:39
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Leap:15.2/python-jaraco.packaging (Old)
and /work/SRC/openSUSE:Leap:15.2/.python-jaraco.packaging.new.26092 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-jaraco.packaging"
Mon Mar 9 18:06:39 2020 rev:8 rq:776691 version:6.1
Changes:
--------
---
/work/SRC/openSUSE:Leap:15.2/python-jaraco.packaging/python-jaraco.base.changes
2020-01-15 15:49:25.219459548 +0100
+++
/work/SRC/openSUSE:Leap:15.2/.python-jaraco.packaging.new.26092/python-jaraco.base.changes
2020-03-09 18:06:40.556856547 +0100
@@ -1,0 +2,8 @@
+Tue Feb 26 07:17:20 UTC 2019 - John Vandenberg <[email protected]>
+
+- Add LICENSE
+- Set version to 6.1 due to version of python-jaraco.packaging,
+ to provide an easy method of ensuring the base is updated with
+ all jaraco modules.
+
+-------------------------------------------------------------------
---
/work/SRC/openSUSE:Leap:15.2/python-jaraco.packaging/python-jaraco.packaging.changes
2020-01-15 15:49:25.251459566 +0100
+++
/work/SRC/openSUSE:Leap:15.2/.python-jaraco.packaging.new.26092/python-jaraco.packaging.changes
2020-03-09 18:06:40.588856563 +0100
@@ -1,0 +2,29 @@
+Mon Oct 14 13:46:38 UTC 2019 - Matej Cepl <[email protected]>
+
+- Run SPEC file through spec-cleaner -i.
+
+-------------------------------------------------------------------
+Tue Feb 26 07:17:20 UTC 2019 - John Vandenberg <[email protected]>
+
+- Add LICENSE
+- Remove bcond_with test, and skip two failing tests
+- Compile manually due to switch to pkgutil namespace technique
+- Add docs/*.rst to %doc
+- Update to v6.1
+ * Sphinx plugin now exposes ``package_url`` in HTML templates.
+- from 6.0
+ * Switch to pkgutil namespace technique for the ``jaraco`` namespace.
+- from 5.2
+ * Show command now also honors direct attributes on a Distribution instance.
+- from 5.1.1
+ * In Sphinx module, use universal newlines to avoid broken results on
Windows.
+- from 5.1
+ * Added ``jaraco.packaging.make-tree`` utility for taking output from
+ pipdeptree and making a tree of it.
+- from 5.0
+ * Drop support for Python 2.6.
+ * Re-aligned to use pkg_resources-managed technique for
+ the jaraco namespace, all package of which must elect one
+ technique or another.
+
+-------------------------------------------------------------------
Old:
----
jaraco.packaging-4.1.tar.gz
New:
----
jaraco.packaging-6.1.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-jaraco.base.spec ++++++
--- /var/tmp/diff_new_pack.aOrx16/_old 2020-03-09 18:06:40.988856761 +0100
+++ /var/tmp/diff_new_pack.aOrx16/_new 2020-03-09 18:06:40.992856763 +0100
@@ -1,7 +1,7 @@
#
# spec file for package python-jaraco.base
#
-# Copyright (c) 2017 SUSE LINUX GmbH, Nuernberg, Germany.
+# Copyright (c) 2019 SUSE LINUX GmbH, Nuernberg, Germany.
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -12,13 +12,13 @@
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
-# Please submit bugfixes or comments via http://bugs.opensuse.org/
+# Please submit bugfixes or comments via https://bugs.opensuse.org/
#
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
Name: python-jaraco.base
-Version: 4.1
+Version: 6.1
Release: 0
Summary: Base namespace for jaraco packages
License: MIT
@@ -53,7 +53,7 @@
}
%files %{python_files}
-%defattr(-,root,root)
+%license LICENSE
%dir %{python_sitelib}/jaraco/
%{python_sitelib}/jaraco/__init__.py*
%pycache_only %dir %{python_sitelib}/jaraco/__pycache__/
++++++ python-jaraco.packaging.spec ++++++
--- /var/tmp/diff_new_pack.aOrx16/_old 2020-03-09 18:06:41.012856773 +0100
+++ /var/tmp/diff_new_pack.aOrx16/_new 2020-03-09 18:06:41.016856775 +0100
@@ -1,7 +1,7 @@
#
# spec file for package python-jaraco.packaging
#
-# Copyright (c) 2017 SUSE LINUX GmbH, Nuernberg, Germany.
+# Copyright (c) 2019 SUSE LINUX GmbH, Nuernberg, Germany.
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -12,30 +12,25 @@
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
-# Please submit bugfixes or comments via http://bugs.opensuse.org/
+# Please submit bugfixes or comments via https://bugs.opensuse.org/
#
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
-%bcond_with test
Name: python-jaraco.packaging
-Version: 4.1
+Version: 6.1
Release: 0
Summary: Supplement packaging Python releases
License: MIT
-Group: Development/Languages/Python
-Url: https://github.com/jaraco/jaraco.packaging
+URL: https://github.com/jaraco/jaraco.packaging
Source:
https://files.pythonhosted.org/packages/source/j/jaraco.packaging/jaraco.packaging-%{version}.tar.gz
-BuildRequires: %{python_module base}
-BuildRequires: %{python_module jaraco.base}
-BuildRequires: %{python_module setuptools}
+BuildRequires: %{python_module jaraco.base >= 6.1}
+BuildRequires: %{python_module pytest}
BuildRequires: %{python_module setuptools_scm}
+BuildRequires: %{python_module setuptools}
BuildRequires: fdupes
BuildRequires: python-rpm-macros
-%if %{with test}
-BuildRequires: %{python_module pytest}
-%endif
-Requires: python-jaraco.base
+Requires: python-jaraco.base >= 6.1
Requires(post): update-alternatives
Requires(preun): update-alternatives
BuildArch: noarch
@@ -46,6 +41,7 @@
%prep
%setup -q -n jaraco.packaging-%{version}
+sed -i 's/--flake8//' pytest.ini
rm -rf jaraco.packaging.egg-info
%build
@@ -56,10 +52,9 @@
# We will package the namespace __init__.py separately
%{python_expand rm %{buildroot}%{$python_sitelib}/jaraco/__init__.py*
rm -rf %{buildroot}%{$python_sitelib}/jaraco/__pycache__/
-%fdupes -s %{buildroot}%{$python_sitelib}
+%fdupes %{buildroot}%{$python_sitelib}
}
-
%python_clone -a %{buildroot}%{_bindir}/dependency-tree
%python_clone -a %{buildroot}%{_bindir}/upload-package
@@ -69,14 +64,16 @@
%postun
%python_uninstall_alternative dependency-tree
-%if %{with test}
%check
-%python_expand py.test-%{$python_bin_suffix}
-%endif
+# Two tests depend on accessing PyPI
+%{python_expand py.test-%{$python_bin_suffix} \
+ --ignore=_build.python3 --ignore _build.python2 \
+ -k 'not (load_dependencies or test_revived_distribution)'
+}
%files %{python_files}
-%defattr(-,root,root)
-%doc CHANGES.rst README.rst
+%license LICENSE
+%doc docs/*.rst CHANGES.rst README.rst
%python_alternative %{_bindir}/dependency-tree
%python_alternative %{_bindir}/upload-package
%{python_sitelib}/jaraco.packaging-%{version}-py*.egg-info
++++++ jaraco.packaging-4.1.tar.gz -> jaraco.packaging-6.1.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/.flake8
new/jaraco.packaging-6.1/.flake8
--- old/jaraco.packaging-4.1/.flake8 1970-01-01 01:00:00.000000000 +0100
+++ new/jaraco.packaging-6.1/.flake8 2019-01-26 18:39:25.000000000 +0100
@@ -0,0 +1,8 @@
+[flake8]
+ignore =
+ # Allow tabs for indentation
+ W191
+ # 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/jaraco.packaging-4.1/.readthedocs.yml
new/jaraco.packaging-6.1/.readthedocs.yml
--- old/jaraco.packaging-4.1/.readthedocs.yml 1970-01-01 01:00:00.000000000
+0100
+++ new/jaraco.packaging-6.1/.readthedocs.yml 2019-01-26 18:39:25.000000000
+0100
@@ -0,0 +1,5 @@
+python:
+ version: 3
+ extra_requirements:
+ - docs
+ pip_install: true
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/.travis.yml
new/jaraco.packaging-6.1/.travis.yml
--- old/jaraco.packaging-4.1/.travis.yml 2017-04-02 19:40:18.000000000
+0200
+++ new/jaraco.packaging-6.1/.travis.yml 2019-01-26 18:39:25.000000000
+0100
@@ -1,24 +1,34 @@
+dist: xenial
sudo: false
language: python
+
python:
- 2.7
- 3.6
+- &latest_py3 3.7
+
+jobs:
+ fast_finish: true
+ include:
+ - stage: deploy
+ if: tag IS present
+ python: *latest_py3
+ before_script: skip
+ env:
+ - TWINE_USERNAME=jaraco
+ # TWINE_PASSWORD
+ - secure:
bxD2vLOczKmaFldcxIdFBAVhMLv9yorkIi2HDH/mHqcA5kxhrZQfGqKnv5lrapbnAdq4nrvLmWq46sA5TDjm3tguLabOPbsTNc0JslyB+/zSYYncXyPxvPbNFDqGu3RLLmt6LDtjXJY2D7MxOav/eDJA4Z7ORn6u8pdjtQ3DbXzeND/Qtw/rr3lfRHriBsYbR2tZ8X8EpcRgZU00Iz1DCayVbUbTodvQ7cQ80NgmfQFLJMJkImaoMZ9lEId1l+AbI3SdOOJV+bTmpZiFhowtTifsI7b5BHlkYPMe/S8qIyzIXBty9trHcWzOzwPlNlLHODtxfYcCkWJggwPnfnhFAHsu1mzALs3fI6bi+vQ+rvuKAvvthkYpHDEZtl0LRBsnetTxLGL+JigKs4LDPcW00fSppfPosjDzGNC/Yz6b4mr9xgfwDRUzV8GsGKZ5JbINktsDsrE2V312mFLTkXCu1/QL2ToBLsi2o9/jz05pEAk55fvIEquPitwvl5EWKc6sU5nmhs0TdOJGYhPDCyaNw8/9lVkMyJ6AbJtVFwOz13O/oOc/1dSTo9ieWYOMfMYkBz0E5LyVfEDfSIZUGQfevSR06Aer4+K4MXKFP9G5AmdaLqRoO0sEPK2+GSlWs/FJUX3W2nwb+LWCVPlcprpLojgI6wGQNXbYYKYpPPR2htk=
+ - TOX_TESTENV_PASSENV="TWINE_USERNAME TWINE_PASSWORD"
+ script: tox -e release
+
+cache: pip
+
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
- distributions: dists
- skip_upload_docs: true
- password:
- secure:
HDOHQAunXzgN0Lzv9j3dIeW10NPF1QXG6ZSnXaKVtowtnE9JSPsXOETokm/TPd6t3FU4rDAgJN38wNqj+MxkAxTOw1jMEF9XDX11dfnnd74sfGSOJkqs+Z7TCu8jKlpib8eYhBtJMBkKtMUAY+4lKSrn3vamiXKKc6WJ/rXDhsIKnqVYqAZ2kL2AdIHhar+scD/5zDc0UHcHdS8Al1s2+tYOaJ2O6Y2nqmt4ouiHHrEvaZevv2jBrl8bo8FdU5KcHjUM8RBuyYdEpYHw5+uRe5RqNdnoId3Q5aXFc+PykVIEuPTLIJUEWxtYbRTpaalIzNCCFzkxb86A3mRftWKPpEaUqVBRdeNgXqUlxMXfCbw/rkxaZPcYaTlt511vwJfhXVrZGV7C13gxcsNn/gDtMs0ErlRuHxA5+ZBJnFDyPEKRllmGT4aoejj6MvKTOiw0NfV+7oTzrot4Bnr7iJO/i9dVTpPbaR+k4VHckkIKOdB/BjLDvBBrgQqiczONdmN+iw26bxCsvyR/ijbnJnNlbWJJZKZaF3eXYjO2flFBieebdwLSUg0zGlNUcq9REureKKc7Hi90xiOOYcU4Et0g23YEDCacHn54eekrKYZe7KD30AePZxc8y029n5hNZ+gzw8ghBx680Y6dhn1T5eM5NdbfW95gAx3ZgQKT3izgHFU=
+- pip install tox tox-venv
+
+before_script:
+ # Disable IPv6. Ref travis-ci/travis-ci#8361
+ - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then
+ sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6';
+ fi
+script: tox
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/CHANGES.rst
new/jaraco.packaging-6.1/CHANGES.rst
--- old/jaraco.packaging-4.1/CHANGES.rst 2017-04-02 19:40:18.000000000
+0200
+++ new/jaraco.packaging-6.1/CHANGES.rst 2019-01-26 18:39:25.000000000
+0100
@@ -1,3 +1,42 @@
+6.1
+===
+
+Sphinx plugin now exposes ``package_url`` in HTML templates.
+
+6.0
+===
+
+Switch to `pkgutil namespace technique
+<https://packaging.python.org/guides/packaging-namespace-packages/#pkgutil-style-namespace-packages>`_
+for the ``jaraco`` namespace.
+
+5.2
+===
+
+Show command now also honors direct attributes on a
+Distribution instance.
+
+5.1.1
+=====
+
+#2: In Sphinx module, use universal newlines to avoid
+broken results on Windows.
+
+5.1
+===
+
+Added ``jaraco.packaging.make-tree`` utility for taking
+output from pipdeptree and making a tree of it.
+
+5.0
+===
+
+Drop support for Python 2.6.
+
+Re-aligned to use pkg_resources-managed technique for
+the jaraco namespace, all package of which must elect one
+technique or another.
+
4.1
===
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/LICENSE
new/jaraco.packaging-6.1/LICENSE
--- old/jaraco.packaging-4.1/LICENSE 1970-01-01 01:00:00.000000000 +0100
+++ new/jaraco.packaging-6.1/LICENSE 2019-01-26 18:39:25.000000000 +0100
@@ -0,0 +1,7 @@
+Copyright Jason R. Coombs
+
+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.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/PKG-INFO
new/jaraco.packaging-6.1/PKG-INFO
--- old/jaraco.packaging-4.1/PKG-INFO 2017-04-02 19:40:41.000000000 +0200
+++ new/jaraco.packaging-6.1/PKG-INFO 2019-01-26 18:39:43.000000000 +0100
@@ -1,6 +1,6 @@
-Metadata-Version: 1.1
+Metadata-Version: 2.1
Name: jaraco.packaging
-Version: 4.1
+Version: 6.1
Summary: tools to supplement packaging Python releases
Home-page: https://github.com/jaraco/jaraco.packaging
Author: Jason R. Coombs
@@ -11,19 +11,16 @@
.. image:: https://img.shields.io/pypi/pyversions/jaraco.packaging.svg
- .. image:: https://img.shields.io/pypi/dm/jaraco.packaging.svg
-
.. image::
https://img.shields.io/travis/jaraco/jaraco.packaging/master.svg
- :target: http://travis-ci.org/jaraco/jaraco.packaging
+ :target: https://travis-ci.org/jaraco/jaraco.packaging
- Tools for packaging.
+ .. .. image::
https://img.shields.io/appveyor/ci/jaraco/skeleton/master.svg
+ .. :target:
https://ci.appveyor.com/project/jaraco/skeleton/branch/master
- License
- =======
+ .. image::
https://readthedocs.org/projects/jaracopackaging/badge/?version=latest
+ :target:
https://jaracopackaging.readthedocs.io/en/latest/?badge=latest
- License is indicated in the project metadata (typically one or more
- of the Trove classifiers). For more details, see `this explanation
- <https://github.com/jaraco/skeleton/issues/1>`_.
+ Tools for packaging.
dependency_tree
===============
@@ -74,11 +71,23 @@
extensions=['jaraco.packaging.sphinx']
+ make-tree
+ =========
+
+ A utility for taking output from ``pipdeptree --json`` and producing a
tree
+ rooted at a given package.
+
+ Usage::
+
+ pipdeptree --json | python -m jaraco.packaging.make-tree mypkg
+
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx :: Extension
+Requires-Python: >=2.7
+Provides-Extra: docs
+Provides-Extra: testing
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/README.rst
new/jaraco.packaging-6.1/README.rst
--- old/jaraco.packaging-4.1/README.rst 2017-04-02 19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/README.rst 2019-01-26 18:39:25.000000000 +0100
@@ -3,19 +3,16 @@
.. image:: https://img.shields.io/pypi/pyversions/jaraco.packaging.svg
-.. image:: https://img.shields.io/pypi/dm/jaraco.packaging.svg
-
.. image:: https://img.shields.io/travis/jaraco/jaraco.packaging/master.svg
- :target: http://travis-ci.org/jaraco/jaraco.packaging
+ :target: https://travis-ci.org/jaraco/jaraco.packaging
-Tools for packaging.
+.. .. image:: https://img.shields.io/appveyor/ci/jaraco/skeleton/master.svg
+.. :target: https://ci.appveyor.com/project/jaraco/skeleton/branch/master
-License
-=======
+.. image::
https://readthedocs.org/projects/jaracopackaging/badge/?version=latest
+ :target: https://jaracopackaging.readthedocs.io/en/latest/?badge=latest
-License is indicated in the project metadata (typically one or more
-of the Trove classifiers). For more details, see `this explanation
-<https://github.com/jaraco/skeleton/issues/1>`_.
+Tools for packaging.
dependency_tree
===============
@@ -65,3 +62,13 @@
'jaraco.packaging.sphinx' to your list of extensions in your config file::
extensions=['jaraco.packaging.sphinx']
+
+make-tree
+=========
+
+A utility for taking output from ``pipdeptree --json`` and producing a tree
+rooted at a given package.
+
+Usage::
+
+ pipdeptree --json | python -m jaraco.packaging.make-tree mypkg
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/appveyor.yml
new/jaraco.packaging-6.1/appveyor.yml
--- old/jaraco.packaging-4.1/appveyor.yml 1970-01-01 01:00:00.000000000
+0100
+++ new/jaraco.packaging-6.1/appveyor.yml 2019-01-26 18:39:25.000000000
+0100
@@ -0,0 +1,24 @@
+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
+
+cache:
+ - '%LOCALAPPDATA%\pip\Cache'
+
+test_script:
+ - "python -m pip install tox tox-venv"
+ - "tox"
+
+version: '{build}'
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/docs/conf.py
new/jaraco.packaging-6.1/docs/conf.py
--- old/jaraco.packaging-4.1/docs/conf.py 2017-04-02 19:40:18.000000000
+0200
+++ new/jaraco.packaging-6.1/docs/conf.py 2019-01-26 18:39:25.000000000
+0100
@@ -1,58 +1,26 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
-import os
-import sys
-import subprocess
-import datetime
+extensions = ["sphinx.ext.autodoc", "jaraco.packaging.sphinx", "rst.linker"]
-if 'check_output' not in dir(subprocess):
- import subprocess32 as subprocess
-
-extensions = [
- 'sphinx.ext.autodoc',
- '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')
-
-origin_date = datetime.date(2015,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
-
-master_doc = 'index'
+master_doc = "index"
link_files = {
- '../CHANGES.rst': dict(
- using=dict(
- GH='https://github.com',
- project=project,
- url=url,
- ),
- replace=[
- dict(
- pattern=r"(Issue )?#(?P<issue>\d+)",
- url='{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}/',
- ),
- ],
- ),
+ "../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)((?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}/",
+ ),
+ ],
+ )
}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/docs/index.rst
new/jaraco.packaging-6.1/docs/index.rst
--- old/jaraco.packaging-4.1/docs/index.rst 2017-04-02 19:40:18.000000000
+0200
+++ new/jaraco.packaging-6.1/docs/index.rst 2019-01-26 18:39:25.000000000
+0100
@@ -12,6 +12,26 @@
:undoc-members:
:show-inheritance:
+.. automodule:: jaraco.packaging.cheese
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. automodule:: jaraco.packaging.depends
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. automodule:: jaraco.packaging.info
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. automodule:: jaraco.packaging.sphinx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
Indices and tables
==================
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/docs/requirements.txt
new/jaraco.packaging-6.1/docs/requirements.txt
--- old/jaraco.packaging-4.1/docs/requirements.txt 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/docs/requirements.txt 1970-01-01
01:00:00.000000000 +0100
@@ -1 +0,0 @@
-rst.linker
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/jaraco/__init__.py
new/jaraco.packaging-6.1/jaraco/__init__.py
--- old/jaraco.packaging-4.1/jaraco/__init__.py 2017-04-02 19:40:18.000000000
+0200
+++ new/jaraco.packaging-6.1/jaraco/__init__.py 2019-01-26 18:39:25.000000000
+0100
@@ -1 +1 @@
-__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/jaraco/packaging/cheese.py
new/jaraco.packaging-6.1/jaraco/packaging/cheese.py
--- old/jaraco.packaging-4.1/jaraco/packaging/cheese.py 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco/packaging/cheese.py 2019-01-26
18:39:25.000000000 +0100
@@ -20,6 +20,10 @@
DistFile = collections.namedtuple('DistFile', 'command pyversion filename')
+# cause setuptools to monkey patch distutils
+__import__('setuptools')
+
+
class TarGZAdapter(object):
"""
Wrap a TarFile object to emulate a ZipFile object
@@ -39,6 +43,7 @@
Open an archive (tarball or zip) and return the object.
"""
name, ext = os.path.splitext(os.path.basename(filename))
+
def targz_handler(stream):
return TarGZAdapter(tarfile.open(fileobj=stream, mode='r:gz'))
cls = [zipfile.ZipFile, targz_handler]['gz' in ext]
@@ -104,8 +109,9 @@
if not isinstance(desc, six.text_type):
desc = desc.decode('utf-8')
lines = io.StringIO(desc)
+
def trim_eight_spaces(line):
- if line.startswith(' '*8):
+ if line.startswith(' ' * 8):
line = line[8:]
return line
lines = itertools.chain(
@@ -117,7 +123,8 @@
def _update_dist_files(self):
if self.filename.endswith('.egg'):
type = 'bdist_egg'
- if self.filename.endswith('.tgz') or self.filename.endswith('.zip') or
self.filename.endswith('.tar.gz'):
+ sdist_exts = '.tgz', 'zip', '.tar.gz'
+ if any(self.filename.endswith(ext) for ext in sdist_exts):
type = 'sdist'
version_pattern = re.compile(r'py\d\.\d')
res = version_pattern.search(self.filename)
@@ -131,7 +138,8 @@
def get_version(self):
return self.package.version
- def has_ext_modules(self): return False
+ def has_ext_modules(self):
+ return False
def cleanup(self):
if self._is_remote():
@@ -165,8 +173,9 @@
If spec already looks like a URL, just return it. Otherwise, assume
it is a filename and return it as a file url.
"""
- if urllib.parse.urlparse(spec).scheme: return spec
- return 'file:'+spec
+ if urllib.parse.urlparse(spec).scheme:
+ return spec
+ return 'file:' + spec
def get_args():
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/jaraco/packaging/depends.py
new/jaraco.packaging-6.1/jaraco/packaging/depends.py
--- old/jaraco.packaging-4.1/jaraco/packaging/depends.py 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco/packaging/depends.py 2019-01-26
18:39:25.000000000 +0100
@@ -14,7 +14,8 @@
text_type = getattr(__builtins__, 'unicode', str)
-req_help = ("A setuptools requirement spec (e.g. 'eggmonster' or "
+req_help = (
+ "A setuptools requirement spec (e.g. 'eggmonster' or "
"'eggmonster==0.1')")
python_help = "Use a remote environment rather than the local one."
@@ -31,13 +32,14 @@
def print_package(requirement, indent):
r = requirement
- print(' ' * indent + str(r), '[{0}]'.format(
- pkg_resources.get_distribution(r))
- )
+ print(
+ ' ' * indent + str(r),
+ '[{0}]'.format(pkg_resources.get_distribution(r)),
+ )
def parse_extras(req):
- pattern = re.compile('\[(.*)\]')
+ pattern = re.compile(r'\[(.*)\]')
res = pattern.search(text_type(req))
return res.group(1).split(',') if res else []
@@ -49,8 +51,10 @@
environment.
"""
# keep a history to avoid infinite loops
- if history is None: history = set()
- if req in history: return
+ if history is None:
+ history = set()
+ if req in history:
+ return
history.add(req)
d = pkg_resources.get_distribution(req)
extras = parse_extras(req)
@@ -70,7 +74,8 @@
>>> import json
>>> doc = json.dumps(deps)
"""
- if history is None: history = set()
+ if history is None:
+ history = set()
dist = pkg_resources.get_distribution(req)
spec = dict(
requirement=str(req),
@@ -84,7 +89,8 @@
load_dependencies(dep, history=history)
for dep in dist.requires(extras=extras)
]
- if depends: spec.update(depends=depends)
+ if depends:
+ spec.update(depends=depends)
return spec
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/jaraco/packaging/info.py
new/jaraco.packaging-6.1/jaraco/packaging/info.py
--- old/jaraco.packaging-4.1/jaraco/packaging/info.py 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco/packaging/info.py 2019-01-26
18:39:25.000000000 +0100
@@ -1,3 +1,5 @@
+from __future__ import print_function
+
import subprocess
import re
@@ -7,6 +9,18 @@
class Show(setuptools.Command):
+ """
+ >>> import sys, functools
+ >>> show_cmd = [sys.executable, "setup.py", "show"]
+ >>> run = functools.partial(
+ ... subprocess.check_output, universal_newlines=True)
+ >>> print(run(show_cmd + ['-a', 'name']), end='')
+ running show
+ jaraco.packaging
+ >>> print(run(show_cmd + ['-a', 'install_requires']), end='')
+ running show
+ "['six>=1.4', 'setuptools']"
+ """
description = "Report attributes of a distribution's metadata"
user_options = [
(str('attributes='), str('a'), "space or comma-separated attributes"),
@@ -20,8 +34,18 @@
self.attributes = 'name', 'version'
def _lookup_attribute(self, attr_name):
+ return self._by_getter(attr_name) or self._by_attr(attr_name)
+
+ def _by_attr(self, attr_name):
+ return getattr(self.distribution, attr_name)
+
+ def _by_getter(self, attr_name):
method_name = 'get_' + attr_name
- return getattr(self.distribution, method_name)()
+ try:
+ method = getattr(self.distribution, method_name)
+ except AttributeError:
+ return
+ return method()
def run(self):
values = map(self._lookup_attribute, self.attributes)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/jaraco/packaging/make-tree.py
new/jaraco.packaging-6.1/jaraco/packaging/make-tree.py
--- old/jaraco.packaging-4.1/jaraco/packaging/make-tree.py 1970-01-01
01:00:00.000000000 +0100
+++ new/jaraco.packaging-6.1/jaraco/packaging/make-tree.py 2019-01-26
18:39:25.000000000 +0100
@@ -0,0 +1,46 @@
+"""
+Take json output from pipdeptree --json and make it into
+a tree rooted at the indicated package.
+"""
+
+import sys
+import json
+import itertools
+
+
+def by_package_key(item):
+ return by_key(item['package'])
+
+
+def by_key(item):
+ return item['key']
+
+
+def main():
+ root, = sys.argv[1:]
+ pkgs = Packages.from_defn(json.load(sys.stdin))
+ json.dump(pkgs.make_tree(root), sys.stdout)
+
+
+class Packages(dict):
+ @classmethod
+ def from_defn(cls, items):
+ return cls(
+ (key, next(items))
+ for key, items in itertools.groupby(items,
by_package_key)
+ )
+
+ def make_tree(self, target):
+ vars(self).setdefault('visited', set())
+ root = self[target].copy()
+ if target in self.visited:
+ # short-circuit circular dependencies
+ del root['dependencies']
+ return root
+ self.visited.add(target)
+ deps_names = map(by_key, root['dependencies'])
+ root['dependencies'] = list(map(self.make_tree, deps_names))
+ return root
+
+
+__name__ == '__main__' and main()
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/jaraco/packaging/sphinx.py
new/jaraco.packaging-6.1/jaraco/packaging/sphinx.py
--- old/jaraco.packaging-4.1/jaraco/packaging/sphinx.py 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco/packaging/sphinx.py 2019-01-26
18:39:25.000000000 +0100
@@ -12,6 +12,7 @@
def setup(app):
app.add_config_value('package_url', '', '')
app.connect('builder-inited', load_config_from_setup)
+ app.connect('html-page-context', add_package_url)
def load_config_from_setup(app):
@@ -23,10 +24,18 @@
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)
- outputs = output_bytes.decode('utf-8').strip().split('\n')
+ output = subprocess.check_output(
+ dist_info_cmd,
+ cwd=root,
+ universal_newlines=True,
+ )
+ outputs = output.strip().split('\n')
project, version, url, author = outputs
app.config.project = project
app.config.version = app.config.release = version
app.config.package_url = url
app.config.author = app.config.copyright = author
+
+
+def add_package_url(app, pagename, templatename, context, doctree):
+ context['package_url'] = app.config.package_url
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/jaraco.packaging-4.1/jaraco.packaging.egg-info/PKG-INFO
new/jaraco.packaging-6.1/jaraco.packaging.egg-info/PKG-INFO
--- old/jaraco.packaging-4.1/jaraco.packaging.egg-info/PKG-INFO 2017-04-02
19:40:41.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco.packaging.egg-info/PKG-INFO 2019-01-26
18:39:43.000000000 +0100
@@ -1,6 +1,6 @@
-Metadata-Version: 1.1
+Metadata-Version: 2.1
Name: jaraco.packaging
-Version: 4.1
+Version: 6.1
Summary: tools to supplement packaging Python releases
Home-page: https://github.com/jaraco/jaraco.packaging
Author: Jason R. Coombs
@@ -11,19 +11,16 @@
.. image:: https://img.shields.io/pypi/pyversions/jaraco.packaging.svg
- .. image:: https://img.shields.io/pypi/dm/jaraco.packaging.svg
-
.. image::
https://img.shields.io/travis/jaraco/jaraco.packaging/master.svg
- :target: http://travis-ci.org/jaraco/jaraco.packaging
+ :target: https://travis-ci.org/jaraco/jaraco.packaging
- Tools for packaging.
+ .. .. image::
https://img.shields.io/appveyor/ci/jaraco/skeleton/master.svg
+ .. :target:
https://ci.appveyor.com/project/jaraco/skeleton/branch/master
- License
- =======
+ .. image::
https://readthedocs.org/projects/jaracopackaging/badge/?version=latest
+ :target:
https://jaracopackaging.readthedocs.io/en/latest/?badge=latest
- License is indicated in the project metadata (typically one or more
- of the Trove classifiers). For more details, see `this explanation
- <https://github.com/jaraco/skeleton/issues/1>`_.
+ Tools for packaging.
dependency_tree
===============
@@ -74,11 +71,23 @@
extensions=['jaraco.packaging.sphinx']
+ make-tree
+ =========
+
+ A utility for taking output from ``pipdeptree --json`` and producing a
tree
+ rooted at a given package.
+
+ Usage::
+
+ pipdeptree --json | python -m jaraco.packaging.make-tree mypkg
+
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx :: Extension
+Requires-Python: >=2.7
+Provides-Extra: docs
+Provides-Extra: testing
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/jaraco.packaging-4.1/jaraco.packaging.egg-info/SOURCES.txt
new/jaraco.packaging-6.1/jaraco.packaging.egg-info/SOURCES.txt
--- old/jaraco.packaging-4.1/jaraco.packaging.egg-info/SOURCES.txt
2017-04-02 19:40:41.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco.packaging.egg-info/SOURCES.txt
2019-01-26 18:39:43.000000000 +0100
@@ -1,14 +1,19 @@
+.flake8
+.readthedocs.yml
.travis.yml
CHANGES.rst
+LICENSE
README.rst
+appveyor.yml
+pyproject.toml
pytest.ini
setup.cfg
setup.py
+skeleton.md
tox.ini
docs/conf.py
docs/history.rst
docs/index.rst
-docs/requirements.txt
jaraco/__init__.py
jaraco.packaging.egg-info/PKG-INFO
jaraco.packaging.egg-info/SOURCES.txt
@@ -20,6 +25,6 @@
jaraco/packaging/cheese.py
jaraco/packaging/depends.py
jaraco/packaging/info.py
+jaraco/packaging/make-tree.py
jaraco/packaging/sphinx.py
-tests/requirements.txt
tests/test_cheese.py
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/jaraco.packaging-4.1/jaraco.packaging.egg-info/requires.txt
new/jaraco.packaging-6.1/jaraco.packaging.egg-info/requires.txt
--- old/jaraco.packaging-4.1/jaraco.packaging.egg-info/requires.txt
2017-04-02 19:40:41.000000000 +0200
+++ new/jaraco.packaging-6.1/jaraco.packaging.egg-info/requires.txt
2019-01-26 18:39:43.000000000 +0100
@@ -1,4 +1,12 @@
six>=1.4
+setuptools
-[:python_version=="2.6"]
-subprocess32
+[docs]
+sphinx
+jaraco.packaging>=3.2
+rst.linker>=1.9
+
+[testing]
+pytest!=3.7.3,>=3.5
+pytest-checkdocs
+pytest-flake8
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/pyproject.toml
new/jaraco.packaging-6.1/pyproject.toml
--- old/jaraco.packaging-4.1/pyproject.toml 1970-01-01 01:00:00.000000000
+0100
+++ new/jaraco.packaging-6.1/pyproject.toml 2019-01-26 18:39:25.000000000
+0100
@@ -0,0 +1,3 @@
+[build-system]
+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/jaraco.packaging-4.1/pytest.ini
new/jaraco.packaging-6.1/pytest.ini
--- old/jaraco.packaging-4.1/pytest.ini 2017-04-02 19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/pytest.ini 2019-01-26 18:39:25.000000000 +0100
@@ -1,4 +1,11 @@
[pytest]
-norecursedirs=dist build .tox
-addopts=--doctest-modules
+norecursedirs=dist build .tox .eggs
+addopts=--doctest-modules --flake8
doctest_optionflags=ALLOW_UNICODE ELLIPSIS
+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/jaraco.packaging-4.1/setup.cfg
new/jaraco.packaging-6.1/setup.cfg
--- old/jaraco.packaging-4.1/setup.cfg 2017-04-02 19:40:41.000000000 +0200
+++ new/jaraco.packaging-6.1/setup.cfg 2019-01-26 18:39:43.000000000 +0100
@@ -1,12 +1,50 @@
-[aliases]
-release = dists upload
-dists = clean --all sdist bdist_wheel
-
-[wheel]
+[bdist_wheel]
universal = 1
+[metadata]
+license_file = LICENSE
+name = jaraco.packaging
+author = Jason R. Coombs
+author_email = [email protected]
+description = tools to supplement packaging Python releases
+long_description = file:README.rst
+url = https://github.com/jaraco/jaraco.packaging
+classifiers =
+ Development Status :: 5 - Production/Stable
+ Intended Audience :: Developers
+ License :: OSI Approved :: MIT License
+ Programming Language :: Python :: 2.7
+ Programming Language :: Python :: 3
+ Framework :: Sphinx :: Extension
+
+[options]
+packages = find:
+include_package_data = true
+python_requires = >=2.7
+install_requires =
+ six >= 1.4
+ setuptools
+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]
+console_scripts =
+ dependency-tree=jaraco.packaging.depends:tree_cmd
+ upload-package=jaraco.packaging.cheese:do_upload
+distutils.commands =
+ dependency_tree=jaraco.packaging.depends:DependencyTree
+ show=jaraco.packaging.info:Show
+
[egg_info]
tag_build =
tag_date = 0
-tag_svn_revision = 0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/setup.py
new/jaraco.packaging-6.1/setup.py
--- old/jaraco.packaging-4.1/setup.py 2017-04-02 19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/setup.py 2019-01-26 18:39:25.000000000 +0100
@@ -1,57 +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 = 'jaraco.packaging'
-description = 'tools to supplement packaging Python releases'
-
-params = dict(
- name=name,
- use_scm_version=True,
- author="Jason R. Coombs",
- author_email="[email protected]",
- description=description or name,
- long_description=long_description,
- url="https://github.com/jaraco/"; + name,
- packages=setuptools.find_packages(),
- include_package_data=True,
- install_requires=[
- 'six>=1.4',
- ],
- extras_require={
- ':python_version=="2.6"': [
- 'subprocess32',
- ],
- },
- 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.6",
- "Programming Language :: Python :: 2.7",
- "Programming Language :: Python :: 3",
- "Framework :: Sphinx :: Extension",
- ],
- entry_points={
- 'console_scripts': [
- 'dependency-tree=jaraco.packaging.depends:tree_cmd',
- 'upload-package=jaraco.packaging.cheese:do_upload',
- ],
- 'distutils.commands': [
-
'dependency_tree=jaraco.packaging.depends:DependencyTree',
- 'show=jaraco.packaging.info:Show',
- ],
- },
-)
-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/jaraco.packaging-4.1/skeleton.md
new/jaraco.packaging-6.1/skeleton.md
--- old/jaraco.packaging-4.1/skeleton.md 1970-01-01 01:00:00.000000000
+0100
+++ new/jaraco.packaging-6.1/skeleton.md 2019-01-26 18:39:25.000000000
+0100
@@ -0,0 +1,126 @@
+# 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.
+
+# 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/jaraco.packaging-4.1/tests/requirements.txt
new/jaraco.packaging-6.1/tests/requirements.txt
--- old/jaraco.packaging-4.1/tests/requirements.txt 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/tests/requirements.txt 1970-01-01
01:00:00.000000000 +0100
@@ -1,2 +0,0 @@
-pytest >= 2.8
-subprocess32; python_version=="2.6"
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/tests/test_cheese.py
new/jaraco.packaging-6.1/tests/test_cheese.py
--- old/jaraco.packaging-4.1/tests/test_cheese.py 2017-04-02
19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/tests/test_cheese.py 2019-01-26
18:39:25.000000000 +0100
@@ -4,6 +4,7 @@
from jaraco.packaging import cheese
+
def test_revived_distribution():
base = 'https://pypi.python.org/packages/source/'
nose_timer_path = 'n/nose-timer/nose-timer-0.3.0.tar.gz'
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/jaraco.packaging-4.1/tox.ini
new/jaraco.packaging-6.1/tox.ini
--- old/jaraco.packaging-4.1/tox.ini 2017-04-02 19:40:18.000000000 +0200
+++ new/jaraco.packaging-6.1/tox.ini 2019-01-26 18:39:25.000000000 +0100
@@ -1,6 +1,31 @@
+[tox]
+envlist = python
+minversion = 2.4
+
[testenv]
deps =
- -rtests/requirements.txt
-
-commands = py.test {posargs}
+ setuptools>=31.0.1
+commands =
+ pytest {posargs}
usedevelop = True
+extras = testing
+
+[testenv:build-docs]
+extras =
+ docs
+ testing
+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/*
