Hello community,
here is the log from the commit of package python3-sphinxcontrib-issuetracker
for openSUSE:Factory checked in at 2015-01-08 23:03:01
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python3-sphinxcontrib-issuetracker (Old)
and /work/SRC/openSUSE:Factory/.python3-sphinxcontrib-issuetracker.new
(New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python3-sphinxcontrib-issuetracker"
Changes:
--------
---
/work/SRC/openSUSE:Factory/python3-sphinxcontrib-issuetracker/python3-sphinxcontrib-issuetracker.changes
2013-06-21 19:09:04.000000000 +0200
+++
/work/SRC/openSUSE:Factory/.python3-sphinxcontrib-issuetracker.new/python3-sphinxcontrib-issuetracker.changes
2015-01-08 23:03:03.000000000 +0100
@@ -1,0 +2,12 @@
+Thu Jan 8 00:30:52 UTC 2015 - [email protected]
+
+- specfile:
+ * update copyright year
+ * update url
+
+- update to version 0.11:
+ * Send proper user agent in API requests
+ * #4: Respect Github rate limits
+ * #5: Fix compatibility with requests 1.0
+
+-------------------------------------------------------------------
Old:
----
sphinxcontrib-issuetracker-0.10.1.tar.gz
New:
----
sphinxcontrib-issuetracker-0.11.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python3-sphinxcontrib-issuetracker.spec ++++++
--- /var/tmp/diff_new_pack.VLO0aP/_old 2015-01-08 23:03:04.000000000 +0100
+++ /var/tmp/diff_new_pack.VLO0aP/_new 2015-01-08 23:03:04.000000000 +0100
@@ -1,7 +1,7 @@
#
# spec file for package python3-sphinxcontrib-issuetracker
#
-# Copyright (c) 2013 SUSE LINUX Products GmbH, Nuernberg, Germany.
+# Copyright (c) 2015 SUSE LINUX Products GmbH, Nuernberg, Germany.
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -11,26 +11,27 @@
# case the license is the MIT License). An "Open Source License" is a
# 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/
#
+
Name: python3-sphinxcontrib-issuetracker
-Version: 0.10.1
+Version: 0.11
Release: 0
-Url: http://packages.python.org/sphinxcontrib-issuetracker
+Url: https://pypi.python.org/pypi/sphinxcontrib-issuetracker
Summary: Sphinx integration with different issuetrackers
License: BSD-2-Clause
Group: Development/Languages/Python
Source:
http://pypi.python.org/packages/source/s/sphinxcontrib-issuetracker/sphinxcontrib-issuetracker-%{version}.tar.gz
BuildRoot: %{_tmppath}/%{name}-%{version}-build
BuildRequires: python3
+BuildRequires: python3-Sphinx
BuildRequires: python3-devel
BuildRequires: python3-distribute
BuildRequires: python3-requests
-BuildRequires: python3-Sphinx
-Requires: python3-requests
Requires: python3-Sphinx
+Requires: python3-requests
BuildArch: noarch
%description
++++++ sphinxcontrib-issuetracker-0.10.1.tar.gz ->
sphinxcontrib-issuetracker-0.11.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/CHANGES.rst
new/sphinxcontrib-issuetracker-0.11/CHANGES.rst
--- old/sphinxcontrib-issuetracker-0.10.1/CHANGES.rst 2012-06-19
11:41:57.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/CHANGES.rst 2013-01-17
12:20:48.000000000 +0100
@@ -1,3 +1,11 @@
+0.11 (Jan 17, 2013)
+===================
+
+- Send proper user agent in API requests
+- #4: Respect Github rate limits
+- #5: Fix compatibility with requests 1.0
+
+
0.10.1 (Jun 19, 2012)
=====================
@@ -174,4 +182,3 @@
==================
- Initial release
-
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/CREDITS
new/sphinxcontrib-issuetracker-0.11/CREDITS
--- old/sphinxcontrib-issuetracker-0.10.1/CREDITS 2012-06-19
11:41:36.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/CREDITS 2012-06-28 17:12:27.000000000
+0200
@@ -2,7 +2,7 @@
-------
sphinxcontrib-issuetracker is written and maintained by Sebastian Wiesner
-<[email protected]>
+<[email protected]>
The following people, listed alphabetically, contributed to this extension or
supported its development otherwise:
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/LICENSE
new/sphinxcontrib-issuetracker-0.11/LICENSE
--- old/sphinxcontrib-issuetracker-0.10.1/LICENSE 2012-06-18
13:28:24.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/LICENSE 2012-06-28 17:12:27.000000000
+0200
@@ -1,4 +1,4 @@
-Copyright (c) 2010, Sebastian Wiesner <[email protected]>
+Copyright (c) 2010, 2011, 2012 Sebastian Wiesner <[email protected]>
All rights reserved.
Redistribution and use in source and binary forms, with or without
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/PKG-INFO
new/sphinxcontrib-issuetracker-0.11/PKG-INFO
--- old/sphinxcontrib-issuetracker-0.10.1/PKG-INFO 2012-06-19
11:42:26.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/PKG-INFO 2013-01-17
12:21:40.000000000 +0100
@@ -1,10 +1,10 @@
-Metadata-Version: 1.1
+Metadata-Version: 1.0
Name: sphinxcontrib-issuetracker
-Version: 0.10.1
+Version: 0.11
Summary: Sphinx integration with different issuetrackers
Home-page: http://sphinxcontrib-issuetracker.readthedocs.org/
Author: Sebastian Wiesner
-Author-email: [email protected]
+Author-email: [email protected]
License: BSD
Description: ##########################
sphinxcontrib-issuetracker
@@ -36,10 +36,12 @@
Installation
------------
- This extension can be installed from the Python Package Index::
+ This extension can be installed from the `Python Package Index`_::
pip install sphinxcontrib-issuetracker
+ This extension requires Sphinx 1.1 and Pythonn 2.6 or Python 3.1.
+
Usage
-----
@@ -66,11 +68,50 @@
For more details refer to the documentation_.
+ Support
+ -------
+
+ Please report issues to the `issue tracker`_ if you have trouble,
found a bug in
+ this extension or lack support for a specific issue tracker, but
respect the
+ following rules:
+
+ - Check that the issue has not already been reported.
+ - Check that the issue is not already fixed in the ``master`` branch.
+ - Open issues with clear title and a detailed description in
grammatically
+ correct, complete sentences.
+
+
+ Development
+ -----------
+
+ The source code is hosted on Github_:
+
+ git clone https://github.com/lunaryorn/sphinxcontrib-issuetracker
+
+ Please fork the repository and send pull requests with your fixes or
cool new
+ features, but respect the following rules:
+
+ - Read `how to properly contribute to open source projects on GitHub
+ <http://gun.io/blog/how-to-github-fork-branch-and-pull-request/>`_.
+ - Use a topic branch to easily amend a pull request later, if
necessary.
+ - Write `good commit messages
+
<http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
+ - Squash commits on the topic branch before opening a pull request.
+ - Respect :pep:`8` (use `pep8`_ to check your coding style compliance)
+ - Add unit tests
+ - Open a `pull request
<https://help.github.com/articles/using-pull-requests>`_
+ that relates to but one subject with a clear title and description in
+ grammatically correct, complete sentences.
+
+
.. _Sphinx: http://sphinx.pocoo.org/latest
- .. _documentation:
http://packages.python.org/sphinxcontrib-issuetracker
+ .. _documentation: http://sphinxcontrib-issuetracker.readthedocs.org
+ .. _Python package index:
http://pypi.python.org/pypi/sphinxcontrib-issuetracker
+ .. _issue tracker:
https://github.com/lunaryorn/sphinxcontrib-issuetracker/issues/
+ .. _pep8: http://pypi.python.org/pypi/pep8/
Platform: any
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/README.rst
new/sphinxcontrib-issuetracker-0.11/README.rst
--- old/sphinxcontrib-issuetracker-0.10.1/README.rst 2012-06-19
10:54:42.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/README.rst 2012-07-10
18:52:35.000000000 +0200
@@ -28,10 +28,12 @@
Installation
------------
-This extension can be installed from the Python Package Index::
+This extension can be installed from the `Python Package Index`_::
pip install sphinxcontrib-issuetracker
+This extension requires Sphinx 1.1 and Pythonn 2.6 or Python 3.1.
+
Usage
-----
@@ -58,5 +60,44 @@
For more details refer to the documentation_.
+Support
+-------
+
+Please report issues to the `issue tracker`_ if you have trouble, found a bug
in
+this extension or lack support for a specific issue tracker, but respect the
+following rules:
+
+- Check that the issue has not already been reported.
+- Check that the issue is not already fixed in the ``master`` branch.
+- Open issues with clear title and a detailed description in grammatically
+ correct, complete sentences.
+
+
+Development
+-----------
+
+The source code is hosted on Github_:
+
+ git clone https://github.com/lunaryorn/sphinxcontrib-issuetracker
+
+Please fork the repository and send pull requests with your fixes or cool new
+features, but respect the following rules:
+
+- Read `how to properly contribute to open source projects on GitHub
+ <http://gun.io/blog/how-to-github-fork-branch-and-pull-request/>`_.
+- Use a topic branch to easily amend a pull request later, if necessary.
+- Write `good commit messages
+ <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
+- Squash commits on the topic branch before opening a pull request.
+- Respect :pep:`8` (use `pep8`_ to check your coding style compliance)
+- Add unit tests
+- Open a `pull request <https://help.github.com/articles/using-pull-requests>`_
+ that relates to but one subject with a clear title and description in
+ grammatically correct, complete sentences.
+
+
.. _Sphinx: http://sphinx.pocoo.org/latest
-.. _documentation: http://packages.python.org/sphinxcontrib-issuetracker
+.. _documentation: http://sphinxcontrib-issuetracker.readthedocs.org
+.. _Python package index:
http://pypi.python.org/pypi/sphinxcontrib-issuetracker
+.. _issue tracker:
https://github.com/lunaryorn/sphinxcontrib-issuetracker/issues/
+.. _pep8: http://pypi.python.org/pypi/pep8/
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/doc/conf.py
new/sphinxcontrib-issuetracker-0.11/doc/conf.py
--- old/sphinxcontrib-issuetracker-0.10.1/doc/conf.py 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/doc/conf.py 2012-06-28
17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -24,17 +24,11 @@
# POSSIBILITY OF SUCH DAMAGE.
-import os
-import sys
import re
from sphinx import addnodes
-doc_directory = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(os.path.normpath(
- os.path.join(doc_directory, os.pardir, 'sphinxcontrib')))
-
-import issuetracker
+from sphinxcontrib import issuetracker
needs_sphinx = '1.0'
@@ -45,7 +39,7 @@
master_doc = 'index'
project = u'sphinxcontrib-issuetracker'
-copyright = u'2010, 2011, Sebastian Wiesner'
+copyright = u'2010, 2011, 2012 Sebastian Wiesner'
version = '.'.join(issuetracker.__version__.split('.')[:2])
release = issuetracker.__version__
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/doc/index.rst
new/sphinxcontrib-issuetracker-0.11/doc/index.rst
--- old/sphinxcontrib-issuetracker-0.10.1/doc/index.rst 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/doc/index.rst 2012-07-10
18:52:35.000000000 +0200
@@ -1,7 +1,7 @@
-:mod:`sphinxcontrib.issuetracker` -- Reference issues in issue trackers
-=======================================================================
+sphinxcontrib.issuetracker -- Reference issues in issue trackers
+================================================================
-A Sphinx_ extension to to reference issues in an issue tracker.
+A Sphinx_ extension to reference issues in an issue tracker.
The extension is available under the terms of the BSD license, see
:doc:`license` for more information.
@@ -10,17 +10,18 @@
Installation
------------
-This extension needs Sphinx 1.0 and Python 2.6 or newer, including Python 3.
+Use ``pip`` to install this extension straight from the `Python Package
+Index`_::
+
+ pip install sphinxcontrib-issuetracker
+
+This extension requires Sphinx 1.1 and Python 2.6 or Python 3.1.
.. note::
Some builtin issue trackers do *not* support Python 3 currently. Refer to
:confval:`issuetracker` for more information.
-Use ``pip`` to install this extension straight from the Python Package Index::
-
- pip install sphinx-contrib.issuetracker
-
Usage
-----
@@ -104,3 +105,4 @@
.. _Sphinx: http://sphinx.pocoo.org/
.. _issue tracker:
https://github.com/lunaryorn/sphinxcontrib-issuetracker/issues/
.. _pep8: http://pypi.python.org/pypi/pep8/
+.. _python package index:
http://pypi.python.org/pypi/sphinxcontrib-issuetracker
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/setup.py
new/sphinxcontrib-issuetracker-0.11/setup.py
--- old/sphinxcontrib-issuetracker-0.10.1/setup.py 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/setup.py 2013-01-17
11:37:06.000000000 +0100
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, 2012, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, 2012, 2013, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -53,12 +53,12 @@
url='http://sphinxcontrib-issuetracker.readthedocs.org/',
license='BSD',
author='Sebastian Wiesner',
- author_email='[email protected]',
+ author_email='[email protected]',
description='Sphinx integration with different issuetrackers',
long_description=long_desc,
zip_safe=False,
classifiers=[
- 'Development Status :: 4 - Beta',
+ 'Development Status :: 5 - Production/Stable',
'Environment :: Console',
'Environment :: Web Environment',
'Intended Audience :: Developers',
@@ -73,6 +73,6 @@
platforms='any',
packages=find_packages(),
include_package_data=True,
- install_requires=['Sphinx>=1.1', 'requests>=0.13'],
+ install_requires=['Sphinx>=1.1', 'requests>=1.1'],
namespace_packages=['sphinxcontrib'],
)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib/issuetracker/__init__.py
new/sphinxcontrib-issuetracker-0.11/sphinxcontrib/issuetracker/__init__.py
---
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib/issuetracker/__init__.py
2012-06-18 20:21:09.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/sphinxcontrib/issuetracker/__init__.py
2012-12-26 00:52:11.000000000 +0100
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2010, 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2010, 2011, 2012 Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -33,14 +33,14 @@
Provide explicit and (optionally) implicit (e.g. ``#10``) references to
issues in issue trackers.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
absolute_import)
-__version__ = '0.10.1'
+__version__ = '0.11'
import sys
import re
@@ -304,7 +304,7 @@
app.info(bold('Copying issuetracker stylesheet... '), nonl=True)
dest = path.join(app.builder.outdir, '_static', 'issuetracker.css')
source = path.join(path.abspath(path.dirname(__file__)),
- 'issuetracker.css')
+ 'issuetracker.css')
copyfile(source, dest)
app.info('done')
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib/issuetracker/resolvers.py
new/sphinxcontrib-issuetracker-0.11/sphinxcontrib/issuetracker/resolvers.py
---
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib/issuetracker/resolvers.py
2012-06-18 18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/sphinxcontrib/issuetracker/resolvers.py
2013-01-17 12:18:34.000000000 +0100
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2010, 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2010, 2011, 2012, 2013 Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -30,16 +30,18 @@
Builtin resolvers for :mod:`sphinxcontrib.issuetracker`.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
absolute_import)
+import time
+
import requests
from xml.etree import ElementTree as etree
-from sphinxcontrib.issuetracker import Issue
+from sphinxcontrib.issuetracker import Issue, __version__
GITHUB_API_URL = 'https://api.github.com/repos/{0.project}/issues/{1}'
@@ -66,6 +68,11 @@
tracker_config))
+HEADERS = {
+ 'User-Agent': 'sphinxcontrib-issuetracker v{0}'.format(__version__)
+}
+
+
def get(app, url):
"""
Get a response from the given ``url``.
@@ -77,7 +84,7 @@
``None`` otherwise. If the status code is not 200 or 404, a warning is
emitted via ``app``.
"""
- response = requests.get(url)
+ response = requests.get(url, headers=HEADERS)
if response.status_code == requests.codes.ok:
return response
elif response.status_code != requests.codes.not_found:
@@ -88,13 +95,29 @@
def lookup_github_issue(app, tracker_config, issue_id):
check_project_with_username(tracker_config)
- url = GITHUB_API_URL.format(tracker_config, issue_id)
- response = get(app, url)
- if response:
- issue = response.json
- closed = issue['state'] == 'closed'
- return Issue(id=issue_id, title=issue['title'], closed=closed,
- url=issue['html_url'])
+ # Get rate limit information from the environment
+ timestamp, limit_hit = getattr(app.env, 'github_rate_limit', (0, False))
+
+ if limit_hit and time.time() - timestamp > 3600:
+ # Github limits applications hourly
+ limit_hit = False
+
+ if not limit_hit:
+ url = GITHUB_API_URL.format(tracker_config, issue_id)
+ response = get(app, url)
+ if response:
+ rate_remaining = response.headers.get('X-RateLimit-Remaining')
+ if rate_remaining.isdigit() and int(rate_remaining) == 0:
+ app.warn('Github rate limit hit')
+ app.env.github_rate_limit = (time.time(), True)
+ issue = response.json()
+ closed = issue['state'] == 'closed'
+ return Issue(id=issue_id, title=issue['title'], closed=closed,
+ url=issue['html_url'])
+ else:
+ app.warn('Github rate limit exceeded, not resolving issue {0}'.format(
+ issue_id))
+ return None
def lookup_bitbucket_issue(app, tracker_config, issue_id):
@@ -103,7 +126,7 @@
url = BITBUCKET_API_URL.format(tracker_config, issue_id)
response = get(app, url)
if response:
- issue = response.json
+ issue = response.json()
closed = issue['status'] not in ('new', 'open')
url = BITBUCKET_URL.format(tracker_config, issue_id)
return Issue(id=issue_id, title=issue['title'], closed=closed, url=url)
@@ -127,8 +150,7 @@
def lookup_launchpad_issue(app, tracker_config, issue_id):
from launchpadlib.launchpad import Launchpad
- launchpad = Launchpad.login_anonymously(
- 'sphinxcontrib.issuetracker', service_root='production')
+ launchpad = Launchpad.login_anonymously('sphinxcontrib.issuetracker')
try:
# get the bug
bug = launchpad.bugs[issue_id]
@@ -185,4 +207,4 @@
'launchpad': lookup_launchpad_issue,
'google code': lookup_google_code_issue,
'jira': lookup_jira_issue,
- }
+}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib_issuetracker.egg-info/PKG-INFO
new/sphinxcontrib-issuetracker-0.11/sphinxcontrib_issuetracker.egg-info/PKG-INFO
---
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib_issuetracker.egg-info/PKG-INFO
2012-06-19 11:42:24.000000000 +0200
+++
new/sphinxcontrib-issuetracker-0.11/sphinxcontrib_issuetracker.egg-info/PKG-INFO
2013-01-17 12:21:31.000000000 +0100
@@ -1,10 +1,10 @@
-Metadata-Version: 1.1
+Metadata-Version: 1.0
Name: sphinxcontrib-issuetracker
-Version: 0.10.1
+Version: 0.11
Summary: Sphinx integration with different issuetrackers
Home-page: http://sphinxcontrib-issuetracker.readthedocs.org/
Author: Sebastian Wiesner
-Author-email: [email protected]
+Author-email: [email protected]
License: BSD
Description: ##########################
sphinxcontrib-issuetracker
@@ -36,10 +36,12 @@
Installation
------------
- This extension can be installed from the Python Package Index::
+ This extension can be installed from the `Python Package Index`_::
pip install sphinxcontrib-issuetracker
+ This extension requires Sphinx 1.1 and Pythonn 2.6 or Python 3.1.
+
Usage
-----
@@ -66,11 +68,50 @@
For more details refer to the documentation_.
+ Support
+ -------
+
+ Please report issues to the `issue tracker`_ if you have trouble,
found a bug in
+ this extension or lack support for a specific issue tracker, but
respect the
+ following rules:
+
+ - Check that the issue has not already been reported.
+ - Check that the issue is not already fixed in the ``master`` branch.
+ - Open issues with clear title and a detailed description in
grammatically
+ correct, complete sentences.
+
+
+ Development
+ -----------
+
+ The source code is hosted on Github_:
+
+ git clone https://github.com/lunaryorn/sphinxcontrib-issuetracker
+
+ Please fork the repository and send pull requests with your fixes or
cool new
+ features, but respect the following rules:
+
+ - Read `how to properly contribute to open source projects on GitHub
+ <http://gun.io/blog/how-to-github-fork-branch-and-pull-request/>`_.
+ - Use a topic branch to easily amend a pull request later, if
necessary.
+ - Write `good commit messages
+
<http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
+ - Squash commits on the topic branch before opening a pull request.
+ - Respect :pep:`8` (use `pep8`_ to check your coding style compliance)
+ - Add unit tests
+ - Open a `pull request
<https://help.github.com/articles/using-pull-requests>`_
+ that relates to but one subject with a clear title and description in
+ grammatically correct, complete sentences.
+
+
.. _Sphinx: http://sphinx.pocoo.org/latest
- .. _documentation:
http://packages.python.org/sphinxcontrib-issuetracker
+ .. _documentation: http://sphinxcontrib-issuetracker.readthedocs.org
+ .. _Python package index:
http://pypi.python.org/pypi/sphinxcontrib-issuetracker
+ .. _issue tracker:
https://github.com/lunaryorn/sphinxcontrib-issuetracker/issues/
+ .. _pep8: http://pypi.python.org/pypi/pep8/
Platform: any
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib_issuetracker.egg-info/requires.txt
new/sphinxcontrib-issuetracker-0.11/sphinxcontrib_issuetracker.egg-info/requires.txt
---
old/sphinxcontrib-issuetracker-0.10.1/sphinxcontrib_issuetracker.egg-info/requires.txt
2012-06-19 11:42:24.000000000 +0200
+++
new/sphinxcontrib-issuetracker-0.11/sphinxcontrib_issuetracker.egg-info/requires.txt
2013-01-17 12:21:31.000000000 +0100
@@ -1,2 +1,2 @@
Sphinx>=1.1
-requests>=0.13
\ No newline at end of file
+requests>=1.1
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/tests/conftest.py
new/sphinxcontrib-issuetracker-0.11/tests/conftest.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/conftest.py 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/conftest.py 2012-06-28
17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/tests/pypi.py
new/sphinxcontrib-issuetracker-0.11/tests/pypi.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/pypi.py 2012-06-19
11:00:04.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/pypi.py 2013-01-17
11:59:29.000000000 +0100
@@ -1,6 +1,6 @@
-# -*- coding: utf8 -*-
-#
+# -*- coding: utf-8 -*-
# Copyright (c) 2009 Python Software Foundation
+# Copyright (c) 2013 Sebastian Wiesner <[email protected]>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
@@ -42,6 +42,9 @@
import sys
from urlparse import urlparse
+# Work around docutils #3596884, see
+#
http://sourceforge.net/tracker/?func=detail&aid=3596884&group_id=38414&atid=422030
+import docutils.utils
from docutils import io, readers
from docutils.core import publish_doctree, Publisher
from docutils.transforms import TransformError
@@ -102,13 +105,13 @@
'file_insertion_enabled': 0, # no file/URL access
'halt_level': 2, # at warnings or errors, raise an exception
'report_level': 5, # never report problems with the reST code
- }
+ }
parts = None
# Convert reStructuredText to HTML using Docutils.
document = publish_doctree(source=source,
- settings_overrides=settings_overrides)
+ settings_overrides=settings_overrides)
for node in document.traverse():
if node.tagname == '#text':
@@ -126,7 +129,7 @@
# now turn the transformed document into HTML
reader = readers.doctree.Reader(parser_name='null')
pub = Publisher(reader, source=io.DocTreeInput(document),
- destination_class=io.StringOutput)
+ destination_class=io.StringOutput)
pub.set_writer('html')
pub.process_programmatic_settings(None, settings_overrides, None)
pub.set_destination(None, None)
@@ -139,3 +142,14 @@
output = output.encode(output_encoding)
return output
+
+
+def main():
+ filename = sys.argv[1]
+ with open(filename) as source:
+ output = process_description(source.read().decode('utf-8'))
+ print(output)
+
+
+if __name__ == '__main__':
+ main()
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_builtin_trackers.py
new/sphinxcontrib-issuetracker-0.11/tests/test_builtin_trackers.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_builtin_trackers.py
2012-06-18 18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_builtin_trackers.py
2013-01-17 11:52:44.000000000 +0100
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, 2012, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, 2012, 2013, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -32,7 +32,7 @@
These tests are mainly intended to make sure that changes to the extension
internals or to the public API of the issue trackers don't break resolval.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
@@ -236,7 +236,7 @@
SPHINX_URL = 'https://bitbucket.org/birkenfeld/sphinx/issue/{0}/'
issues = {
'resolved': Issue(id='478', closed=True, url=SPHINX_URL.format('478'),
- title='Adapt py:decorator from Python docs'),
+ title='Adapt py:decorator from Python docs'),
'invalid': Issue(id='327', closed=True, url=SPHINX_URL.format('327'),
title='Spaces at the end of console messages'),
'duplicate': Issue(id='733', closed=True, url=SPHINX_URL.format('733'),
@@ -308,15 +308,16 @@
default_tracker_config = TrackerConfig('inkscape')
tracker_config = {'wrong project': TrackerConfig('foo'),
- 'invalid': TrackerConfig('null')}
+ 'invalid': TrackerConfig('eject (Ubuntu)')}
issues = {
'closed': Issue('647789', title='tries to install file(s) outside of '
'./configure\'s --prefix', closed=True,
url='https://bugs.launchpad.net/bugs/647789'),
- 'invalid': Issue('1000', closed=True,
- title='There are too many bug reports in Malone',
- url='https://bugs.launchpad.net/bugs/1000'),
+ 'invalid': Issue('173307', closed=True,
+ title='All users should be able to eject CDs and '
+ 'removable media',
+ url='https://bugs.launchpad.net/bugs/173307'),
'wrong project': '1000',
'no issue': '1000000',
}
@@ -330,9 +331,6 @@
'resolved': Issue('SHERPA-15', closed=True, title='Breadcrumbs and '
'page title missing from admin screens',
url='https://studio.atlassian.com/browse/SHERPA-15'),
- 'open': Issue('PYO-84', closed=False,
- title='Implement LLSD login in pyogp',
- url='https://jira.secondlife.com/browse/PYO-84'),
}
tracker_config = {
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_lookup.py
new/sphinxcontrib-issuetracker-0.11/tests/test_lookup.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_lookup.py 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_lookup.py 2012-06-28
17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
Test issue lookup.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/tests/test_pypi.py
new/sphinxcontrib-issuetracker-0.11/tests/test_pypi.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_pypi.py 2012-06-19
11:02:06.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_pypi.py 2013-01-17
11:59:02.000000000 +0100
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, 2012 Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,13 +29,15 @@
Test that this package is handled correctly on the cheeseshop.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
absolute_import)
import os
+import sys
+from subprocess import Popen, PIPE, CalledProcessError
import pytest
@@ -44,12 +46,19 @@
def test_description_rendering():
"""
If this test raises any exception ReST rendering on PyPI will fail.
+
+ It calls out to the renderer via subprocess to get a clean docutils import.
+ Sphinx heavily monkey-patches some docutils internals, which causes
+ different rendering and sometimes even exceptions.
"""
- from pypi import process_description
test_directory = os.path.abspath(os.path.dirname(__file__))
source_directory = os.path.abspath(os.path.join(test_directory, os.pardir))
+ pypi = os.path.join(test_directory, 'pypi.py')
readme = os.path.join(source_directory, 'README.rst')
- with open(readme) as source:
- output = process_description(source.read().decode('utf-8'))
- assert output is not None
- assert output != ''
+
+ cmd = [sys.executable, pypi, readme]
+ proc = Popen(cmd, stdout=PIPE)
+ stdout = proc.communicate()[0]
+ if proc.returncode != 0:
+ raise CalledProcessError(proc.returncode, cmd)
+ assert stdout
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_resolval.py
new/sphinxcontrib-issuetracker-0.11/tests/test_resolval.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_resolval.py
2012-06-18 18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_resolval.py 2012-06-28
17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
Test resolval of pending issue references.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/tests/test_role.py
new/sphinxcontrib-issuetracker-0.11/tests/test_role.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_role.py 2012-06-18
18:33:45.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_role.py 2012-06-28
17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
Test the ``issue`` role.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_setup.py
new/sphinxcontrib-issuetracker-0.11/tests/test_setup.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_setup.py 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_setup.py 2012-06-28
17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -30,7 +30,7 @@
Test the setup procedure of the extension, make sure that everything is
installed at the proper place after the extension setup finished.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_stylesheet.py
new/sphinxcontrib-issuetracker-0.11/tests/test_stylesheet.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_stylesheet.py
2012-06-18 20:34:23.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_stylesheet.py
2012-06-28 17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
Test application of the CSS stylesheet to the HTML output.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_tracker_config.py
new/sphinxcontrib-issuetracker-0.11/tests/test_tracker_config.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_tracker_config.py
2012-06-18 18:33:45.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_tracker_config.py
2012-06-28 17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
Test the TrackerConfig class.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/sphinxcontrib-issuetracker-0.10.1/tests/test_transformer.py
new/sphinxcontrib-issuetracker-0.11/tests/test_transformer.py
--- old/sphinxcontrib-issuetracker-0.10.1/tests/test_transformer.py
2012-06-18 18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tests/test_transformer.py
2012-06-28 17:12:27.000000000 +0200
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
+# Copyright (c) 2011, Sebastian Wiesner <[email protected]>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
Test transforming of textual issue references.
- .. moduleauthor:: Sebastian Wiesner <[email protected]>
+ .. moduleauthor:: Sebastian Wiesner <[email protected]>
"""
from __future__ import (print_function, division, unicode_literals,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/sphinxcontrib-issuetracker-0.10.1/tox.ini
new/sphinxcontrib-issuetracker-0.11/tox.ini
--- old/sphinxcontrib-issuetracker-0.10.1/tox.ini 2012-06-18
18:33:56.000000000 +0200
+++ new/sphinxcontrib-issuetracker-0.11/tox.ini 2013-01-17 11:38:23.000000000
+0100
@@ -1,10 +1,10 @@
[tox]
-envlist=py26,py27,doc
+envlist=py26,py27,py32,pypy
[testenv]
deps=
sphinx>=1.1
- requests>=0.13
+ requests>=1.1
mock>=0.7
pytest>=2.0
; These are not yet compatible to Python 3
@@ -17,7 +17,7 @@
[testenv:py26]
deps=
sphinx>=1.1
- requests>=0.13
+ requests>=1.1
mock>=0.7
pytest>=2.0
launchpadlib
@@ -29,7 +29,7 @@
[testenv:py27]
deps=
sphinx>=1.1
- requests>=0.13
+ requests>=1.1
mock>=0.7
pytest>=2.0
launchpadlib
--
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
