Config utilities for describing config files and CLI arguments

.travis.yml

@@ -8,7 +8,7 @@ before_install:
  - sudo apt-get update -qq
  - sudo apt-get install -qq sloccount
  - pip install -r requirements.txt
- - pip install pip-tools coviolations_app flake8 coverage coveralls
+ - pip install pip-tools coviolations_app flake8 coverage coveralls testfixtures
 script: python setup.py nosetests --with-coverage --cover-package=xylem > test_result
 notifications:
  email: false

docs/apidoc/xylem.rst

@@ -15,6 +15,30 @@ Subpackages
 Submodules
 ----------
 
+xylem.arguments module
+----------------------
+
+.. automodule:: xylem.arguments
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+xylem.config module
+-------------------
+
+.. automodule:: xylem.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+xylem.config_utils module
+-------------------------
+
+.. automodule:: xylem.config_utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
 xylem.exception module
 ----------------------
 

docs/apidoc/xylem.sources.rst

@@ -20,14 +20,6 @@ xylem.sources.impl module
  :undoc-members:
  :show-inheritance:
 
-xylem.sources.rules_dict module
--------------------------------
-
-.. automodule:: xylem.sources.rules_dict
- :members:
- :undoc-members:
- :show-inheritance:
-
 
 Module contents
 ---------------

docs/apidoc/xylem.specs.plugins.rst

@@ -0,0 +1,22 @@
+xylem.specs.plugins package
+===========================
+
+Submodules
+----------
+
+xylem.specs.plugins.rules module
+--------------------------------
+
+.. automodule:: xylem.specs.plugins.rules
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: xylem.specs.plugins
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/apidoc/xylem.specs.rst

@@ -1,6 +1,13 @@
 xylem.specs package
 ===================
 
+Subpackages
+-----------
+
+.. toctree::
+
+ xylem.specs.plugins
+
 Submodules
 ----------
 
@@ -12,10 +19,10 @@ xylem.specs.impl module
  :undoc-members:
  :show-inheritance:
 
-xylem.specs.rules module
-------------------------
+xylem.specs.rules_dict module
+-----------------------------
 
-.. automodule:: xylem.specs.rules
+.. automodule:: xylem.specs.rules_dict
  :members:
  :undoc-members:
  :show-inheritance:

docs/xylem_api.rst

@@ -23,6 +23,7 @@ Database
 .. automodule:: xylem.update
  :members:
  :undoc-members:
+ :noindex:
 
 Indices and tables
 ------------------

setup.py

@@ -9,7 +9,7 @@
 # http://www.jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/
 
 # see: http://reinout.vanrees.org/weblog/2009/12/17/managing-dependencies.html
-tests_require = ['nose', 'flake8', 'mock', 'coverage']
+tests_require = ['nose', 'flake8', 'mock', 'coverage', 'testfixtures']
 
 setup(
  name='xylem',

test/unit_tests/config/test_config.py

@@ -0,0 +1,19 @@
+# Copyright 2014 Open Source Robotics Foundation, Inc.
+#
+# 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.
+
+"""Unit tests for config module."""
+
+from __future__ import unicode_literals
+
+# TODO

test/unit_tests/config_utils/test_config_api.py

@@ -0,0 +1,19 @@
+# Copyright 2014 Open Source Robotics Foundation, Inc.
+#
+# 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.
+
+"""Test high level API for config_utils."""
+
+from __future__ import unicode_literals
+
+# TODO

test/unit_tests/config_utils/test_config_description.py

@@ -0,0 +1,19 @@
+# Copyright 2014 Open Source Robotics Foundation, Inc.
+#
+# 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.
+
+"""Test creating and using ConfigDescription."""
+
+from __future__ import unicode_literals
+
+# TODO

test/unit_tests/config_utils/test_config_dict.py

@@ -0,0 +1,19 @@
+# Copyright 2014 Open Source Robotics Foundation, Inc.
+#
+# 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.
+
+"""Test functions manipulating config dicts."""
+
+from __future__ import unicode_literals
+
+# TODO