Initial tuning from cookiecutter start

This adds in the initial stab of os_resource_classes.

.coveragerc

@@ -1,6 +1,7 @@
 [run]
 branch = True
 source = os_resource_classes
+omit = os_resource_classes/tests/*
 
 [report]
 ignore_errors = True

.mailmap

@@ -1,3 +0,0 @@
-# Format is:
-# <preferred e-mail> <other e-mail 1>
-# <preferred e-mail> <other e-mail 2>

CONTRIBUTING.rst

@@ -12,4 +12,4 @@ submitted for review via the Gerrit tool:
 
 Pull requests submitted through GitHub will be ignored.
 
-Bugs should be filed on Launchpadhttps://bugs.launchpad.net/nova
+Bugs should be filed on Launchpad: https://bugs.launchpad.net/nova

README.rst

@@ -2,11 +2,11 @@
 os-resource-classes
 ===============================
 
+**WIP**
+
 Resource Classes for OpenStack
 
-Please fill here a long description which must be at least 3 lines wrapped on
+A list of standardized resource classes for OpenStack.
-80 cols, so that distribution package maintainers can use it in their packages.
-Note that this is a hard requirement.
 
 * Free software: Apache license
 * Documentation: https://docs.openstack.org/os-resource-classes/latest

babel.cfg

@@ -1,2 +0,0 @@
-[python: **.py]
-

os_resource_classes/__init__.py

@@ -1,19 +1,57 @@
-# -*- coding: utf-8 -*-
+"""Static symbols for resources classes used by OpenStack.
 
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
+A resource class is a type of countable thing that exists in
-# not use this file except in compliance with the License. You may obtain
+a cloud environment, for example VCPU, DISK_GB. They are
-# a copy of the License at
+upper case with underscores. They often include a unit in their
-#
+name.
-#      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.
 
-import pbr.version
+This package provides a collection of standard resource classes
+which are expected to be available in any OpenStack deployment.
+
+There also exists a concept of custom resource classes. These
+are countable types that are custom to a particular environment.
+The OpenStack placement API provides a way to create these. A
+custom resource class always begins with a "CUSTOM_" prefix.
+"""
+
+import sys
+
+# NOTE(cdent): We don't expect there to be thousands of resource
+# classes and we don't desire to track their history in any
+# particular way so we maintain them as a list of strings ordered by
+# by the time they were added to the list. From that we automatically
+# create symbols in the same package. Ordering is important because
+# it reflects database ids that have been used for resource classes
+# prior to this package existing.
 
 
-__version__ = pbr.version.VersionInfo(
+# Extend this list, if required, by adding **to the end of it**.
-    'os-resource-classes').version_string()
+ORDERED_CLASSES = [
+    # Virtual CPUs
+    'VCPU',
+    # Memory Megabytes
+    'MEMORY_MB',
+    # Disk Gigabytes
+    'DISK_GB',
+    'PCI_DEVICE',
+    'SRIOV_NET_VF',
+    'NUMA_SOCKET',
+    'NUMA_CORE',
+    'NUMA_THREAD',
+    'NUMA_MEMORY_MB',
+    'IPV4_ADDRESS',
+    'VGPU',
+    'VGPU_DISPLAY_HEAD',
+]
+
+# Namespace used for custom resource classes
+CUSTOM_NAMESPACE = 'CUSTOM_'
+
+def is_custom(resource_class):
+    return resource_class.startswith(CUSTOM_NAMESPACE)
+
+
+# Set symbols that match resource class name strings.
+package = sys.modules[__name__]
+for resource_class in ORDERED_CLASSES:
+    setattr(package, resource_class, resource_class)

setup.cfg

@@ -21,17 +21,3 @@ classifier =
 [files]
 packages =
     os_resource_classes
-
-[compile_catalog]
-directory = os_resource_classes/locale
-domain = os_resource_classes
-
-[update_catalog]
-domain = os_resource_classes
-output_dir = os_resource_classes/locale
-input_file = os_resource_classes/locale/os_resource_classes.pot
-
-[extract_messages]
-keywords = _ gettext ngettext l_ lazy_gettext
-mapping_file = babel.cfg
-output_file = os_resource_classes/locale/os_resource_classes.pot