Hello community,
here is the log from the commit of package python-monascaclient for
openSUSE:Factory checked in at 2018-01-31 19:52:05
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-monascaclient (Old)
and /work/SRC/openSUSE:Factory/.python-monascaclient.new (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-monascaclient"
Wed Jan 31 19:52:05 2018 rev:5 rq:571134 version:1.9.0
Changes:
--------
---
/work/SRC/openSUSE:Factory/python-monascaclient/python-monascaclient.changes
2018-01-24 15:27:19.859267529 +0100
+++
/work/SRC/openSUSE:Factory/.python-monascaclient.new/python-monascaclient.changes
2018-01-31 19:52:06.240884776 +0100
@@ -1,0 +2,8 @@
+Tue Jan 30 15:11:53 UTC 2018 - [email protected]
+
+- update to version 1.9.0
+ - Updated from global requirements
+ - Avoid tox_install.sh for constraints support
+ - Enable client documentation
+
+-------------------------------------------------------------------
Old:
----
python-monascaclient-1.8.0.tar.gz
New:
----
python-monascaclient-1.9.0.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-monascaclient.spec ++++++
--- /var/tmp/diff_new_pack.gyqVeJ/_old 2018-01-31 19:52:06.936852412 +0100
+++ /var/tmp/diff_new_pack.gyqVeJ/_new 2018-01-31 19:52:06.936852412 +0100
@@ -18,7 +18,7 @@
%global sname python-monascaclient
Name: python-monascaclient
-Version: 1.8.0
+Version: 1.9.0
Release: 0
Summary: Python API and CLI for OpenStack Monasca
License: Apache-2.0
++++++ python-monascaclient-1.8.0.tar.gz -> python-monascaclient-1.9.0.tar.gz
++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/AUTHORS
new/python-monascaclient-1.9.0/AUTHORS
--- old/python-monascaclient-1.8.0/AUTHORS 2017-10-26 14:52:53.000000000
+0200
+++ new/python-monascaclient-1.9.0/AUTHORS 2017-12-21 20:44:48.000000000
+0100
@@ -49,6 +49,7 @@
Victor Ion Munteanu <[email protected]>
Witold Bedyk <[email protected]>
ZhiQiang Fan <[email protected]>
+Zuul <[email protected]>
bklei <[email protected]>
cindy oneill <[email protected]>
gecong1973 <[email protected]>
@@ -56,6 +57,7 @@
haali1 <[email protected]>
henriquetruta <[email protected]>
howardlee <[email protected]>
+kornicameister <[email protected]>
lingyongxu <[email protected]>
oneilcin <[email protected]>
rajat29 <[email protected]>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/ChangeLog
new/python-monascaclient-1.9.0/ChangeLog
--- old/python-monascaclient-1.8.0/ChangeLog 2017-10-26 14:52:53.000000000
+0200
+++ new/python-monascaclient-1.9.0/ChangeLog 2017-12-21 20:44:48.000000000
+0100
@@ -1,6 +1,14 @@
CHANGES
=======
+1.9.0
+-----
+
+* Updated from global requirements
+* Updated from global requirements
+* Avoid tox\_install.sh for constraints support
+* Enable client documentation
+
1.8.0
-----
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/PKG-INFO
new/python-monascaclient-1.9.0/PKG-INFO
--- old/python-monascaclient-1.8.0/PKG-INFO 2017-10-26 14:52:53.000000000
+0200
+++ new/python-monascaclient-1.9.0/PKG-INFO 2017-12-21 20:44:49.000000000
+0100
@@ -1,8 +1,8 @@
Metadata-Version: 1.1
Name: python-monascaclient
-Version: 1.8.0
+Version: 1.9.0
Summary: Monasca API Client Library
-Home-page: https://github.com/openstack/python-monascaclient
+Home-page: https://docs.openstack.org/python-monascaclient/latest/
Author: OpenStack
Author-email: [email protected]
License: UNKNOWN
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/doc/source/cli/index.rst
new/python-monascaclient-1.9.0/doc/source/cli/index.rst
--- old/python-monascaclient-1.8.0/doc/source/cli/index.rst 1970-01-01
01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/cli/index.rst 2017-12-21
20:42:23.000000000 +0100
@@ -0,0 +1,13 @@
+=========
+Using CLI
+=========
+
+monasca CLI
+-----------
+
+.. toctree::
+ :maxdepth: 2
+
+ monasca CLI guide <monasca>
+ monasca CLI formatting <monasca-formatting>
+ monasca CLI debugging <monasca-debug>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/doc/source/cli/monasca-debug.rst
new/python-monascaclient-1.9.0/doc/source/cli/monasca-debug.rst
--- old/python-monascaclient-1.8.0/doc/source/cli/monasca-debug.rst
1970-01-01 01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/cli/monasca-debug.rst
2017-12-21 20:42:23.000000000 +0100
@@ -0,0 +1,12 @@
+=========
+Debugging
+=========
+
+``-v`` (or ``--verbose``), as well as ``--debug``, option can be used
+to increase amount of low-level details regarding all the steps that
+client takes in order to execute the CLI command.
+
+While ``--verbose`` does not dramatically increase the output by displaying
+only basic information about the the execution, ``--debug`` can be used
+to additionally display low-level interactions **monascaclient** make with
+**keystone** server and/or **monasca** server.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/doc/source/cli/monasca-formatting.rst
new/python-monascaclient-1.9.0/doc/source/cli/monasca-formatting.rst
--- old/python-monascaclient-1.8.0/doc/source/cli/monasca-formatting.rst
1970-01-01 01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/cli/monasca-formatting.rst
2017-12-21 20:42:23.000000000 +0100
@@ -0,0 +1,36 @@
+===================
+Changing formatting
+===================
+
+Changing displayed columns
+--------------------------
+
+If you want displayed columns in a list operation, ``-c`` option can be used.
+``-c`` can be specified multiple times and the column order will be same as
+the order of ``-c`` options.
+
+Changing format
+---------------
+
+If you want to change the format data is displayed in, you can use ``-f``
+option for that. Format can be specified just once and it affects they way
+the data is printed to the ``STDOUT``. The available formats, data can be
+presented in, can be checked with:
+
+.. code-block:: text
+
+ monasca <command> --help
+
+Look for section **output formatters** and the flag ``--format`` or ``-f``.
+In most of the cases you will be able to pick one out of
+``csv``, ``json``, ``table``, ``value``, ``yaml``.
+
+Affecting the width
+-------------------
+
+If, for some reason, you are not happy with the width the output has taken, you
+can use ```--max-width {number}``` flag and set the value to
+match your preference. Without that output will not be constrained
+by the terminal width. Alternatively you may want to pass ``--fit-width``
+to fit the output to display width. Remember that these flags
+affect the output only if ``table`` formatter is used.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/doc/source/cli/monasca.rst
new/python-monascaclient-1.9.0/doc/source/cli/monasca.rst
--- old/python-monascaclient-1.8.0/doc/source/cli/monasca.rst 1970-01-01
01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/cli/monasca.rst 2017-12-21
20:42:23.000000000 +0100
@@ -0,0 +1,92 @@
+=================
+Using monasca CLI
+=================
+
+The **monasca** shell utility interacts with OpenStack Monitoring API from the
+command-line. It supports the entire features of OpenStack Monitoring API.
+
+Basic Usage
+-----------
+
+In order to use the CLI, you must provide your OpenStack username, password,
+project, domain information for both user and project, and auth endpoint. Use
+the corresponding configuration options (``--os-username``, ``--os-password``,
+``--os-project-name``, ``--os-user-domain-id``, ``os-project-domain-id``, and
+``--os-auth-url``), but it is easier to set them in environment variables.
+
+.. code-block:: shell
+
+ export OS_USERNAME=mini-mon
+ export OS_PASSWORD=password
+ export OS_PROJECT_NAME=mini-mon
+ export OS_USER_DOMAIN_ID=default
+ export OS_PROJECT_DOMAIN_ID=default
+ export OS_AUTH_URL=http://keystone:5000/v3
+
+If you are using Identity v2.0 API (DEPRECATED), you don't need to pass domain
+information.
+
+.. code-block:: shell
+
+ export OS_USERNAME=mini-mon
+ export OS_PASSWORD=password
+ export OS_TENANT_NAME=mini-mon
+ export OS_AUTH_URL=http://keystone:5000/v2.0
+
+Once you've configured your authentication parameters, you can run **monasca**
+commands. All commands take the form of:
+
+.. code-block:: text
+
+ monasca <command> [arguments...]
+
+Run **monasca help** to get a full list of all possible commands, and run
+**monasca help <command>** to get detailed help for that command.
+
+Using with os-client-config
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`os-client-config <https://docs.openstack.org/os-client-config/latest/>`_
+provides more convenient way to manage a collection of client configurations
+and you can easily switch multiple OpenStack-based configurations.
+
+To use os-client-config, you first need to prepare
+``~/.config/openstack/clouds.yaml`` like the following.
+
+.. code-block:: yaml
+
+ clouds:
+ monitoring:
+ auth:
+ auth_url: http://keystone:5000
+ password: password
+ project_domain_id: default
+ project_name: mini-mon
+ user_domain_id: default
+ username: mini-mon
+ identity_api_version: '3'
+ region_name: RegionOne
+
+Then, you need to specify a configuration name defined in the above
+clouds.yaml.
+
+.. code-block:: shell
+
+ export OS_CLOUD=monitoring
+
+For more detail information, see the
+`os-client-config <https://docs.openstack.org/os-client-config/latest/>`_
+documentation.
+
+Using with keystone token
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The command-line tool will attempt to re-authenticate using your provided
+credentials for every request. You can override this behavior by manually
+supplying an auth token using ``--os-url`` and ``--os-auth-token``. You can
+alternatively set these environment variables.
+
+.. code-block:: shell
+
+ export OS_URL=http://monasca.example.org:8070/
+ export OS_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/doc/source/conf.py
new/python-monascaclient-1.9.0/doc/source/conf.py
--- old/python-monascaclient-1.8.0/doc/source/conf.py 1970-01-01
01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/conf.py 2017-12-21
20:42:23.000000000 +0100
@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+
+from monascaclient.version import version_info
+
+sys.path = [
+ os.path.abspath('../..'),
+ os.path.abspath('../../bin')
+] + sys.path
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = '1.6'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.graphviz',
+ 'sphinx.ext.viewcode',
+ 'openstackdocstheme'
+]
+
+# geeneral information about project
+repository_name = u'openstack/python-monascaclient'
+project = u'Monasca Client Dev Docs'
+version = version_info.canonical_version_string()
+release = version_info.version_string_with_vcs()
+bug_project = u'880'
+bug_tag = u''
+copyright = u'2014-present, OpenStack Foundation'
+author = u'OpenStack Foundation'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = [
+ 'common',
+ 'doc',
+ 'documentation',
+ 'etc',
+ 'java'
+]
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'openstackdocs'
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# If false, no index is generated.
+html_use_index = True
+
+# If false, no module index is generated.
+html_use_modindex = True
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'python-monascaclientdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'python-monascaclient.tex', u'python-monascaclient
Documentation',
+ u'Openstack Foundation
\\textless{}[email protected]\\textgreater{}', 'manual'),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'python-monascaclient', u'python-monascaclient Documentation',
+ [author], 1)
+]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'python-monascaclient', u'python-monascaclient Documentation',
+ author, 'python-monascaclient', 'Rest-API to collect logs from your cloud.',
+ 'Miscellaneous'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://doc.python.org/': None}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/doc/source/index.rst
new/python-monascaclient-1.9.0/doc/source/index.rst
--- old/python-monascaclient-1.8.0/doc/source/index.rst 1970-01-01
01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/index.rst 2017-12-21
20:42:23.000000000 +0100
@@ -0,0 +1,46 @@
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+==================================
+python-monascaclient documentation
+==================================
+
+This is a client for OpenStack Monitoring API. It provides
+:doc:`Python API bindings <reference/index>` (the monascaclient module) and
+:doc:`command-line interface (CLI) <cli/index>`.
+
+User Documentation
+------------------
+
+.. toctree::
+ :maxdepth: 2
+
+ cli/index
+ reference/index
+
+Usage
+-----
+
+In the :doc:`Usage <usage/index>`, you will find
+information on possible ways to use python-monascaclient.
+
+.. toctree::
+ :maxdepth: 2
+
+ usage/index
+
+History
+-------
+
+Release notes is available at
+http://docs.openstack.org/releasenotes/python-monascaclient/.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/doc/source/reference/index.rst
new/python-monascaclient-1.9.0/doc/source/reference/index.rst
--- old/python-monascaclient-1.8.0/doc/source/reference/index.rst
1970-01-01 01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/reference/index.rst
2017-12-21 20:42:23.000000000 +0100
@@ -0,0 +1,107 @@
+================
+Using Python API
+================
+
+Python bindings to the OpenStack Monasca API
+============================================
+
+This is a client for the OpenStack Monasca API. It includes a Python
+API (the :mod:`monascaclient` module) and a command-line script
+(installed as :program:`monasca`).
+
+Python API
+==========
+
+To use python-monascaclient in a project, you need to create a client instance
+first. There are couple ways of doing this properly.
+
+With session
+------------
+
+A pseudo-code would be similar to this::
+
+ from keystoneauth1 import identity
+ from keystoneauth1 import session
+ from monascaclient import client
+
+ auth = identity.Password(
+ auth_url='http://my.keystone.com:5000/v3',
+ username='mini-mon',
+ password='password',
+ project_name='mini-mon',
+ user_domain_id='default',
+ project_domain_id='default'
+ )
+ sess = session.Session(auth=auth)
+
+ endpoint = 'http://monasca:8070/'
+ api_version = '2_0'
+
+ c = client.Client(
+ api_version=api_version,
+ endpoint=endpoint,
+ session=session
+ )
+
+ c.alarms.list()
+
+For more information on keystoneauth API, see `Using Sessions`_. We also
+suggest taking closer look at `Keystone Auth Plugins`_. Each of the plugin
+can be used to properly instantiate new session and pass it into the client.
+
+ .. note:: This is recommended way to setup a client.
+ Other cases, described below, create sessions internally.
+
+
+Without session
+---------------
+
+If you do not want to use a session or simply prefer client to instantiate
+one on its own, there are two supported ways
+
+With token
+~~~~~~~~~~
+
+A pseudo-code would be similar to this::
+
+ from monascaclient import client
+
+ c = client.Client(
+ api_version='2_0',
+ endpoint='http://monasca:8070/',
+ token='3bcc3d3a03f44e3d8377f9247b0ad155',
+ project_name='mini-mon',
+ auth_url='http://my.keystone.com:5000/v3'
+ )
+
+ c.alarms.list()
+
+
+With username & password
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+A pseudo-code would be similar to this::
+
+ from monascaclient import client
+
+ c = client.Client(
+ api_version='2_0',
+ endpoint='http://monasca:8070/',
+ username='mini-mon',
+ password='password',
+ project_name='mini-mon',
+ auth_url='http://my.keystone.com:5000/v3'
+ )
+
+ c.alarms.list()
+
+Examples
+========
+
+* `Monasca Agent Example`_ - with session
+* `Monasca UI Example`_ - with token
+
+.. _Monasca Agent Example:
https://github.com/openstack/monasca-agent/blob/master/monasca_agent/forwarder/api/monasca_api.py
+.. _Monasca UI Example:
https://github.com/openstack/monasca-ui/blob/master/monitoring/api/client.py
+.. _Using Sessions:
https://docs.openstack.org/keystoneauth/latest/using-sessions.html
+.. _Keystone Auth Plugins:
https://docs.openstack.org/keystoneauth/latest/authentication-plugins.html
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/doc/source/usage/index.rst
new/python-monascaclient-1.9.0/doc/source/usage/index.rst
--- old/python-monascaclient-1.8.0/doc/source/usage/index.rst 1970-01-01
01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/doc/source/usage/index.rst 2017-12-21
20:42:23.000000000 +0100
@@ -0,0 +1,21 @@
+=====
+Usage
+=====
+
+Devstack
+--------
+
+python-monascaclient is bundled inside `Monasca API Devstack Plugin`_ and is
+available right after the devstack finished stacking up. It is always built
+from the **master** branch, unless specified otherwise.
+
+Docker
+------
+
+The client is also part of `monasca-docker`_, a community effort to put
+**monasca** into containers. The image is available as **monasca/client** and
+can be used as drop-in replacement for traditional way of
+deploying the clients.
+
+.. _Monasca API Devstack Plugin:
https://github.com/openstack/monasca-api/tree/master/devstack
+.. _monasca-docker:
https://github.com/monasca/monasca-docker/tree/master/monasca-client
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/python_monascaclient.egg-info/PKG-INFO
new/python-monascaclient-1.9.0/python_monascaclient.egg-info/PKG-INFO
--- old/python-monascaclient-1.8.0/python_monascaclient.egg-info/PKG-INFO
2017-10-26 14:52:53.000000000 +0200
+++ new/python-monascaclient-1.9.0/python_monascaclient.egg-info/PKG-INFO
2017-12-21 20:44:48.000000000 +0100
@@ -1,8 +1,8 @@
Metadata-Version: 1.1
Name: python-monascaclient
-Version: 1.8.0
+Version: 1.9.0
Summary: Monasca API Client Library
-Home-page: https://github.com/openstack/python-monascaclient
+Home-page: https://docs.openstack.org/python-monascaclient/latest/
Author: OpenStack
Author-email: [email protected]
License: UNKNOWN
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/python_monascaclient.egg-info/SOURCES.txt
new/python-monascaclient-1.9.0/python_monascaclient.egg-info/SOURCES.txt
--- old/python-monascaclient-1.8.0/python_monascaclient.egg-info/SOURCES.txt
2017-10-26 14:52:53.000000000 +0200
+++ new/python-monascaclient-1.9.0/python_monascaclient.egg-info/SOURCES.txt
2017-12-21 20:44:49.000000000 +0100
@@ -10,6 +10,14 @@
setup.py
test-requirements.txt
tox.ini
+doc/source/conf.py
+doc/source/index.rst
+doc/source/cli/index.rst
+doc/source/cli/monasca-debug.rst
+doc/source/cli/monasca-formatting.rst
+doc/source/cli/monasca.rst
+doc/source/reference/index.rst
+doc/source/usage/index.rst
monascaclient/__init__.py
monascaclient/client.py
monascaclient/shell.py
@@ -44,4 +52,8 @@
python_monascaclient.egg-info/pbr.json
python_monascaclient.egg-info/requires.txt
python_monascaclient.egg-info/top_level.txt
-tools/tox_install.sh
\ No newline at end of file
+releasenotes/locale/.gitkeep
+releasenotes/notes/openstack_docs-5cfec48411370070.yaml
+releasenotes/source/conf.py
+releasenotes/source/index.rst
+releasenotes/source/unreleased.rst
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/python_monascaclient.egg-info/pbr.json
new/python-monascaclient-1.9.0/python_monascaclient.egg-info/pbr.json
--- old/python-monascaclient-1.8.0/python_monascaclient.egg-info/pbr.json
2017-10-26 14:52:53.000000000 +0200
+++ new/python-monascaclient-1.9.0/python_monascaclient.egg-info/pbr.json
2017-12-21 20:44:48.000000000 +0100
@@ -1 +1 @@
-{"git_version": "d81d211", "is_release": true}
\ No newline at end of file
+{"git_version": "d7f6fb2", "is_release": true}
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/python_monascaclient.egg-info/requires.txt
new/python-monascaclient-1.9.0/python_monascaclient.egg-info/requires.txt
--- old/python-monascaclient-1.8.0/python_monascaclient.egg-info/requires.txt
2017-10-26 14:52:53.000000000 +0200
+++ new/python-monascaclient-1.9.0/python_monascaclient.egg-info/requires.txt
2017-12-21 20:44:48.000000000 +0100
@@ -1,9 +1,9 @@
osc-lib>=1.7.0
oslo.serialization!=2.19.1,>=2.18.0
-oslo.utils>=3.28.0
+oslo.utils>=3.33.0
Babel!=2.4.0,>=2.3.4
iso8601>=0.1.11
pbr!=2.1.0,>=2.0.0
PrettyTable<0.8,>=0.7.1
PyYAML>=3.10
-six>=1.9.0
+six>=1.10.0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/releasenotes/notes/openstack_docs-5cfec48411370070.yaml
new/python-monascaclient-1.9.0/releasenotes/notes/openstack_docs-5cfec48411370070.yaml
---
old/python-monascaclient-1.8.0/releasenotes/notes/openstack_docs-5cfec48411370070.yaml
1970-01-01 01:00:00.000000000 +0100
+++
new/python-monascaclient-1.9.0/releasenotes/notes/openstack_docs-5cfec48411370070.yaml
2017-12-21 20:42:23.000000000 +0100
@@ -0,0 +1,11 @@
+---
+prelude: >
+ Documentation done right by Openstack process.
+issues:
+ - |
+ Removed the case where command documentation (held previously in markdown)
+ is out-of-sync with the command itself.
+upgrade:
+ - |
+ Added details about using the CLI variant. Documented the usage
+ of Python API.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/releasenotes/source/conf.py
new/python-monascaclient-1.9.0/releasenotes/source/conf.py
--- old/python-monascaclient-1.8.0/releasenotes/source/conf.py 1970-01-01
01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/releasenotes/source/conf.py 2017-12-21
20:42:23.000000000 +0100
@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = '1.6'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'openstackdocstheme',
+ 'reno.sphinxext'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+repository_name = u'openstack/python-monascaclient'
+project = u'Monasca Client ReleaseNotes Docs'
+
+# Release notes do not need a version number in the title, they
+# cover multiple releases.
+version = ''
+release = ''
+bug_project = u'880'
+bug_tag = u''
+copyright = u'2014-present, OpenStack Foundation'
+author = u'OpenStack Foundation'
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'openstackdocs'
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MonascaClientReleaseNotesDoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_documents = [(
+ master_doc, 'MonascaClientReleaseNotes.tex',
+ u'Monasca Client Release Notes', [author],
+ 'manual'
+)]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'monascaclientreleasenotes',
+ u'Monasca Client Release Notes', [author],
+ 1)
+]
+
+# -- Options for Internationalization output ------------------------------
+locale_dirs = ['locale/']
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/releasenotes/source/index.rst
new/python-monascaclient-1.9.0/releasenotes/source/index.rst
--- old/python-monascaclient-1.8.0/releasenotes/source/index.rst
1970-01-01 01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/releasenotes/source/index.rst
2017-12-21 20:42:23.000000000 +0100
@@ -0,0 +1,10 @@
+============================
+Monitoring API Release Notes
+============================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ unreleased
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/python-monascaclient-1.8.0/releasenotes/source/unreleased.rst
new/python-monascaclient-1.9.0/releasenotes/source/unreleased.rst
--- old/python-monascaclient-1.8.0/releasenotes/source/unreleased.rst
1970-01-01 01:00:00.000000000 +0100
+++ new/python-monascaclient-1.9.0/releasenotes/source/unreleased.rst
2017-12-21 20:42:23.000000000 +0100
@@ -0,0 +1,5 @@
+==============================
+ Current Series Release Notes
+==============================
+
+.. release-notes::
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/requirements.txt
new/python-monascaclient-1.9.0/requirements.txt
--- old/python-monascaclient-1.8.0/requirements.txt 2017-10-26
14:49:46.000000000 +0200
+++ new/python-monascaclient-1.9.0/requirements.txt 2017-12-21
20:42:23.000000000 +0100
@@ -5,7 +5,7 @@
osc-lib>=1.7.0 # Apache-2.0
oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0
-oslo.utils>=3.28.0 # Apache-2.0
+oslo.utils>=3.33.0 # Apache-2.0
Babel!=2.4.0,>=2.3.4 # BSD
iso8601>=0.1.11 # MIT
@@ -13,4 +13,4 @@
PrettyTable<0.8,>=0.7.1 # BSD
PyYAML>=3.10 # MIT
-six>=1.9.0 # MIT
+six>=1.10.0 # MIT
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/setup.cfg
new/python-monascaclient-1.9.0/setup.cfg
--- old/python-monascaclient-1.8.0/setup.cfg 2017-10-26 14:52:53.000000000
+0200
+++ new/python-monascaclient-1.9.0/setup.cfg 2017-12-21 20:44:49.000000000
+0100
@@ -4,7 +4,7 @@
description-file = README.rst
author = OpenStack
author-email = [email protected]
-home-page = https://github.com/openstack/python-monascaclient
+home-page = https://docs.openstack.org/python-monascaclient/latest/
classifier =
Environment :: Console
Intended Audience :: Information Technology
@@ -24,8 +24,16 @@
console_scripts =
monasca = monascaclient.shell:main
-[pbr]
-autodoc_index_modules = True
+[build_sphinx]
+source-dir = doc/source
+build-dir = doc/build
+all_files = 1
+warning-is-error = 1
+
+[build_releasenotes]
+all_files = 1
+build-dir = releasenotes/build
+source-dir = releasenotes/source
[wheel]
universal = 1
@@ -33,4 +41,5 @@
[egg_info]
tag_build =
tag_date = 0
+tag_svn_revision = 0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/test-requirements.txt
new/python-monascaclient-1.9.0/test-requirements.txt
--- old/python-monascaclient-1.8.0/test-requirements.txt 2017-10-26
14:49:46.000000000 +0200
+++ new/python-monascaclient-1.9.0/test-requirements.txt 2017-12-21
20:42:23.000000000 +0100
@@ -4,9 +4,16 @@
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
bandit>=1.1.0 # Apache-2.0
+
coverage!=4.4,>=4.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
os-testr>=1.0.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
-testtools>=1.4.0 # MIT
+testtools>=2.2.0 # MIT
+
+# documentation
+doc8>=0.6.0 # Apache-2.0
+sphinx>=1.6.2 # BSD
+reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=1.17.0 # Apache-2.0
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/tools/tox_install.sh
new/python-monascaclient-1.9.0/tools/tox_install.sh
--- old/python-monascaclient-1.8.0/tools/tox_install.sh 2017-10-26
14:49:46.000000000 +0200
+++ new/python-monascaclient-1.9.0/tools/tox_install.sh 1970-01-01
01:00:00.000000000 +0100
@@ -1,30 +0,0 @@
-#!/usr/bin/env bash
-
-# Client constraint file contains this client version pin that is in conflict
-# with installing the client from source. We should remove the version pin in
-# the constraints file before applying it for from-source installation.
-
-CONSTRAINTS_FILE=$1
-shift 1
-
-set -e
-
-# NOTE(tonyb): Place this in the tox enviroment's log dir so it will get
-# published to logs.openstack.org for easy debugging.
-localfile="$VIRTUAL_ENV/log/upper-constraints.txt"
-
-if [[ $CONSTRAINTS_FILE != http* ]]; then
- CONSTRAINTS_FILE=file://$CONSTRAINTS_FILE
-fi
-# NOTE(tonyb): need to add curl to bindep.txt if the project supports bindep
-curl $CONSTRAINTS_FILE --insecure --progress-bar --output $localfile
-
-pip install -c$localfile openstack-requirements
-
-# This is the main purpose of the script: Allow local installation of
-# the current repo. It is listed in constraints file and thus any
-# install will be constrained and we need to unconstrain it.
-edit-constraints $localfile -- $CLIENT_NAME
-
-pip install -c$localfile -U $*
-exit $?
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/python-monascaclient-1.8.0/tox.ini
new/python-monascaclient-1.9.0/tox.ini
--- old/python-monascaclient-1.8.0/tox.ini 2017-10-26 14:49:46.000000000
+0200
+++ new/python-monascaclient-1.9.0/tox.ini 2017-12-21 20:42:23.000000000
+0100
@@ -6,21 +6,21 @@
[testenv]
setenv =
VIRTUAL_ENV={envdir}
- BRANCH_NAME=master
- CLIENT_NAME=python-monascaclient
OS_TEST_PATH=monascaclient/tests
+ PYTHONWARNINGS=default::DeprecationWarning
passenv = *_proxy
*_PROXY
usedevelop = True
-install_command =
- {toxinidir}/tools/tox_install.sh
{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
{opts} {packages}
-deps = -r{toxinidir}/test-requirements.txt
+install_command = pip install {opts} {packages}
+deps =
+
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+ -r{toxinidir}/test-requirements.txt
whitelist_externals = bash
find
rm
commands =
- find . -type f -name "*.pyc" -delete
- rm -Rf .testrepository/times.dbm
+ find {toxinidir} -type f -name "*.pyc" -delete
+ rm -Rf {toxinidir}/.testrepository/times.dbm
[testenv:py27]
basepython = python2.7
@@ -59,22 +59,55 @@
commands =
{[testenv:flake8]commands}
{[testenv:bandit]commands}
+ {[testenv:checkniceness]commands}
[testenv:flake8]
skip_install = True
usedevelop = False
commands =
- flake8 monascaclient
+ {[testenv]commands}
+ flake8 monascaclient
[testenv:bandit]
skip_install = True
usedevelop = False
commands =
+ {[testenv]commands}
bandit -r monascaclient -n5 -x {env:OS_TEST_PATH}
+[testenv:docs]
+description = Builds full monascaclient documentation
+commands =
+ {[testenv]commands}
+ {[testenv:devdocs]commands}
+ {[testenv:releasenotes]commands}
+
+[testenv:devdocs]
+description = Builds developer documentation
+commands =
+ rm -rf {toxinidir}/doc/build {toxinidir}/doc/source/contributor/api
+ python setup.py build_sphinx
+
+[testenv:releasenotes]
+description = Called from CI script to test and publish the Release Notes
+commands =
+ rm -rf releasenotes/build
+ sphinx-build -a -E -d {toxinidir}/releasenotes/build/doctrees -b html
{toxinidir}/releasenotes/source {toxinidir}/releasenotes/build/html
+
+[testenv:checkniceness]
+description = Validates (pep-like) documenation
+commands =
+ {[testenv]commands}
+ doc8 --file-encoding utf-8 {toxinidir}/doc
+ doc8 --file-encoding utf-8 {toxinidir}/releasenotes
+
[testenv:venv]
commands = {posargs}
+[hacking]
+import_exceptions =
+ six.moves
+
[flake8]
show-source = True
max-line-length = 120
