python/python-cliff
SHA256
15
0
Fork 0
forked from pool/python-cliff
Code Pull Requests Activity

Accepting request 514848 from devel:languages:python

Browse Source 
- update to 2.8.0:
  * add tests for display command classes and hooks
  * Run hooks for DisplayCommandBase
  * add --fit-width option to table formatter
  * sphinxext: Add 'application' option to the autoprogram directive
  * use openstackdocstheme html context
  * switch from oslosphinx to openstackdocstheme
  * Fix erroneous line in command hook test
  * make smart help formatter test deterministic
  * remove references to distribute in the docs
  * add before and after hooks
  * add hook for get\_epilog
  * add hook for manipulating the argument parser
  * Updated from global requirements
  * pass the command name from HelpCommand
  * Adjust completenames tests for cmd2 0.7.3+
  * rearrange existing content to follow new standard
  * sphinext: Use metavar where possible
  * sphinxext: Use 'argparse.description', 'argparse.epilog'
  * sphinxext: Allow configuration of ignorable options
  * sphinxext: Generate better usage examples
  * add cmd\_name argument to CompleteCommand
  * Ensure python standard argparse module is loaded
  * Updated from global requirements
  * covert test suite to use testrepository
  * Updated from global requirements
  * Add smart help formatter for command parser
  * Add support for epilogs
  * Add 'autoprogram-cliff' Sphinx directive
  * .gitignore: Ignore eggs

OBS-URL: https://build.opensuse.org/request/show/514848
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-cliff?expand=0&rev=29
This commit is contained in:
Yuchen Lin
2017-08-12 18:26:52 +00:00
committed by Git OBS Bridge
parent 782e8585a8
commit d5e4debb57
5 changed files with 163 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
0001-Make-openstackdocstheme-an-optional-doc-dependency.patch Normal file
View File

@@ -0,0 +1,109 @@
From 5c37935139892a96fe11a563dda9fdcce31edba4 Mon Sep 17 00:00:00 2001
From: Thomas Bechtold <tbechtold@suse.com>
Date: Mon, 7 Aug 2017 09:28:04 +0200
Subject: [PATCH] Make openstackdocstheme an optional doc dependency
cliff is a library that is used outside of OpenStack, too. Having
a build requirement that needs something OpenStack specific makes
life in cases (eg. for downstream packagers) more difficult.
So let's make openstackdocstheme an optional requirement.
Change-Id: I0f94a431be083b8b4baec850b1885ba07b5bf5c2
---
doc/source/conf.py | 19 +++++++++++++++----
setup.cfg | 7 +++++++
test-requirements.txt | 1 -
tox.ini | 1 +
4 files changed, 23 insertions(+), 5 deletions(-)
Index: cliff-2.8.0/doc/source/conf.py
===================================================================
--- cliff-2.8.0.orig/doc/source/conf.py
+++ cliff-2.8.0/doc/source/conf.py
@@ -15,7 +15,15 @@
import datetime
import subprocess
-import openstackdocstheme
+# make openstackdocstheme an optional dependency. cliff is a low level lib
+# that is used outside of OpenStack. Not having something OpenStack specific
+# as build requirement is a good thing.
+try:
+ import openstackdocstheme
+except ImportError:
+ has_openstackdocstheme = False
+else:
+ has_openstackdocstheme = True
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -32,8 +40,9 @@ import openstackdocstheme
# ones.
extensions = [
'sphinx.ext.autodoc',
- 'openstackdocstheme',
]
+if has_openstackdocstheme:
+ extensions.append('openstackdocstheme')
# openstackdocstheme options
repository_name = 'openstack/cliff'
@@ -109,7 +118,8 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'default'
-html_theme = 'openstackdocs'
+if has_openstackdocstheme:
+ html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -118,7 +128,8 @@ html_theme = 'openstackdocs'
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
+if has_openstackdocstheme:
+ html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Index: cliff-2.8.0/setup.cfg
===================================================================
--- cliff-2.8.0.orig/setup.cfg
+++ cliff-2.8.0/setup.cfg
@@ -16,6 +16,13 @@ classifier =
Intended Audience :: Developers
Environment :: Console
+[extras]
+docs =
+ # make openstackdocstheme an optional dependency. cliff is a low level lib
+ # that is used outside of OpenStack. Not having something OpenStack specific
+ # as build requirement is a good thing.
+ openstackdocstheme>=1.16.0 # Apache-2.0
+
[global]
setup-hooks =
pbr.hooks.setup_hook
Index: cliff-2.8.0/test-requirements.txt
===================================================================
--- cliff-2.8.0.orig/test-requirements.txt
+++ cliff-2.8.0/test-requirements.txt
@@ -12,4 +12,3 @@ coverage!=4.4,>=4.0 # Apache-2.0
# this is required for the docs build jobs
sphinx>=1.6.2 # BSD
-openstackdocstheme>=1.11.0 # Apache-2.0
Index: cliff-2.8.0/tox.ini
===================================================================
--- cliff-2.8.0.orig/tox.ini
+++ cliff-2.8.0/tox.ini
@@ -15,6 +15,7 @@ commands =
python setup.py test --coverage --coverage-package-name=cliff --slowest --testr-args='{posargs}'
coverage report --show-missing
deps = -r{toxinidir}/test-requirements.txt
+ .[docs]
[testenv:pep8]
deps = flake8

3
cliff-2.4.0.tar.gz
View File

@@ -1,3 +0,0 @@
version https://git-lfs.github.com/spec/v1
oid sha256:cc9175e3c2a42bc06343290a1218bc6b70f36883520b2948f743c5f9ae917675
size 58088

3
cliff-2.8.0.tar.gz Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a4fd35b3d98f5f806b6f38c97559ad671376f7d54d1e29015dbd6d805a13ff46
size 71815

43
python-cliff.changes
View File

@@ -1,3 +1,46 @@
-------------------------------------------------------------------
Mon Aug 7 07:15:16 UTC 2017 - tbechtold@suse.com
- update to 2.8.0:
* add tests for display command classes and hooks
* Run hooks for DisplayCommandBase
* add --fit-width option to table formatter
* sphinxext: Add 'application' option to the autoprogram directive
* use openstackdocstheme html context
* switch from oslosphinx to openstackdocstheme
* Fix erroneous line in command hook test
* make smart help formatter test deterministic
* remove references to distribute in the docs
* add before and after hooks
* add hook for get\_epilog
* add hook for manipulating the argument parser
* Updated from global requirements
* pass the command name from HelpCommand
* Adjust completenames tests for cmd2 0.7.3+
* rearrange existing content to follow new standard
* sphinext: Use metavar where possible
* sphinxext: Use 'argparse.description', 'argparse.epilog'
* sphinxext: Allow configuration of ignorable options
* sphinxext: Generate better usage examples
* add cmd\_name argument to CompleteCommand
* Ensure python standard argparse module is loaded
* Updated from global requirements
* covert test suite to use testrepository
* Updated from global requirements
* Add smart help formatter for command parser
* Add support for epilogs
* Add 'autoprogram-cliff' Sphinx directive
* .gitignore: Ignore eggs
* Use Sphinx 1.5 warning-is-error
* Update cmd2 fix to still work with 0.6.7
* Remove support for py34
* Fix broken test with cmd2 0.7.0
* Updated from global requirements
* Updated from global requirements
* Updated from global requirements
* Add newline if the output formatter is json
- Add 0001-Make-openstackdocstheme-an-optional-doc-dependency.patch
-------------------------------------------------------------------
Fri Feb 10 16:45:39 UTC 2017 - tbechtold@suse.com

13
python-cliff.spec
View File

@@ -17,13 +17,15 @@
Name: python-cliff
Version: 2.4.0
Version: 2.8.0
Release: 0
Url: https://github.com/dreamhost/cliff
Summary: Command Line Interface Formulation Framework
License: Apache-2.0
Group: Development/Languages/Python
Source: https://pypi.io/packages/source/c/cliff/cliff-%{version}.tar.gz
Source: https://files.pythonhosted.org/packages/source/c/cliff/cliff-%{version}.tar.gz
# PATCH-FEATURE-UPSTREAM 0001-Make-openstackdocstheme-an-optional-doc-dependency.patch -- https://review.openstack.org/491378
Patch1: 0001-Make-openstackdocstheme-an-optional-doc-dependency.patch
BuildRoot: %{_tmppath}/%{name}-%{version}-build
BuildRequires: python-argparse
BuildRequires: python-devel
@@ -38,15 +40,15 @@ BuildRequires: python-mock >= 2.0
BuildRequires: python-nose
BuildRequires: python-oslosphinx
BuildRequires: python-pbr
BuildRequires: python-pyparsing >= 2.0.7
BuildRequires: python-pyparsing >= 2.1.0
BuildRequires: python-six
BuildRequires: python-stevedore
Requires: python-PrettyTable >= 0.7
Requires: python-PyYAML >= 3.10.0
Requires: python-cmd2 >= 0.6.7
Requires: python-pyparsing >= 2.0.7
Requires: python-pyparsing >= 2.1.0
Requires: python-six >= 1.9.0
Requires: python-stevedore >= 1.17.1
Requires: python-stevedore >= 1.20.0
Requires: python-unicodecsv >= 0.8.0
BuildArch: noarch
@@ -69,6 +71,7 @@ This package contains documentation files for %{name}.
%prep
%setup -q -n cliff-%{version}
%patch1 -p1
%build
python setup.py build