From 72bc53b67cb3d8829247d1e631bdf7b198a4206e Mon Sep 17 00:00:00 2001 From: Kiall Mac Innes Date: Sat, 25 May 2013 13:07:04 +0100 Subject: [PATCH] Migrate to PBR Change-Id: I4f32b7c3ca7831becdd49f75a7fa48bfcfa7fe76 --- .../openstack/__init__.py => README.rst | 0 monikerclient/openstack/common/__init__.py | 0 monikerclient/openstack/common/setup.py | 335 ------------------ monikerclient/openstack/common/version.py | 79 ----- monikerclient/version.py | 4 +- openstack-common.conf | 3 - tools/pip-requires => requirements.txt | 2 + setup.cfg | 102 +++++- setup.py | 89 +---- tools/test-requires => test-requirements.txt | 2 - tools/setup-requires | 0 tox.ini | 5 +- 12 files changed, 100 insertions(+), 521 deletions(-) rename monikerclient/openstack/__init__.py => README.rst (100%) delete mode 100644 monikerclient/openstack/common/__init__.py delete mode 100644 monikerclient/openstack/common/setup.py delete mode 100644 monikerclient/openstack/common/version.py delete mode 100644 openstack-common.conf rename tools/pip-requires => requirements.txt (75%) rename tools/test-requires => test-requirements.txt (64%) delete mode 100644 tools/setup-requires diff --git a/monikerclient/openstack/__init__.py b/README.rst similarity index 100% rename from monikerclient/openstack/__init__.py rename to README.rst diff --git a/monikerclient/openstack/common/__init__.py b/monikerclient/openstack/common/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/monikerclient/openstack/common/setup.py b/monikerclient/openstack/common/setup.py deleted file mode 100644 index cc8b99e3..00000000 --- a/monikerclient/openstack/common/setup.py +++ /dev/null @@ -1,335 +0,0 @@ -# vim: tabstop=4 shiftwidth=4 softtabstop=4 - -# Copyright 2011 OpenStack LLC. -# Copyright 2012-2013 Hewlett-Packard Development Company, L.P. -# All Rights Reserved. -# -# 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. - -""" -Utilities with minimum-depends for use in setup.py -""" - -import email -import os -import re -import subprocess -import sys - -from setuptools.command import sdist - - -def parse_mailmap(mailmap='.mailmap'): - mapping = {} - if os.path.exists(mailmap): - with open(mailmap, 'r') as fp: - for l in fp: - try: - canonical_email, alias = re.match( - r'[^#]*?(<.+>).*(<.+>).*', l).groups() - except AttributeError: - continue - mapping[alias] = canonical_email - return mapping - - -def canonicalize_emails(changelog, mapping): - """Takes in a string and an email alias mapping and replaces all - instances of the aliases in the string with their real email. - """ - for alias, email_address in mapping.iteritems(): - changelog = changelog.replace(alias, email_address) - return changelog - - -# Get requirements from the first file that exists -def get_reqs_from_files(requirements_files): - for requirements_file in requirements_files: - if os.path.exists(requirements_file): - with open(requirements_file, 'r') as fil: - return fil.read().split('\n') - return [] - - -def parse_requirements(requirements_files=['requirements.txt', - 'tools/pip-requires']): - requirements = [] - for line in get_reqs_from_files(requirements_files): - # For the requirements list, we need to inject only the portion - # after egg= so that distutils knows the package it's looking for - # such as: - # -e git://github.com/openstack/nova/master#egg=nova - if re.match(r'\s*-e\s+', line): - requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1', - line)) - # such as: - # http://github.com/openstack/nova/zipball/master#egg=nova - elif re.match(r'\s*https?:', line): - requirements.append(re.sub(r'\s*https?:.*#egg=(.*)$', r'\1', - line)) - # -f lines are for index locations, and don't get used here - elif re.match(r'\s*-f\s+', line): - pass - # argparse is part of the standard library starting with 2.7 - # adding it to the requirements list screws distro installs - elif line == 'argparse' and sys.version_info >= (2, 7): - pass - else: - requirements.append(line) - - return requirements - - -def parse_dependency_links(requirements_files=['requirements.txt', - 'tools/pip-requires']): - dependency_links = [] - # dependency_links inject alternate locations to find packages listed - # in requirements - for line in get_reqs_from_files(requirements_files): - # skip comments and blank lines - if re.match(r'(\s*#)|(\s*$)', line): - continue - # lines with -e or -f need the whole line, minus the flag - if re.match(r'\s*-[ef]\s+', line): - dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line)) - # lines that are only urls can go in unmolested - elif re.match(r'\s*https?:', line): - dependency_links.append(line) - return dependency_links - - -def _run_shell_command(cmd, throw_on_error=False): - if os.name == 'nt': - output = subprocess.Popen(["cmd.exe", "/C", cmd], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - else: - output = subprocess.Popen(["/bin/sh", "-c", cmd], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - if output.returncode and throw_on_error: - raise Exception("%s returned %d" % cmd, output.returncode) - out = output.communicate() - if len(out) == 0: - return None - if len(out[0].strip()) == 0: - return None - return out[0].strip() - - -def write_git_changelog(): - """Write a changelog based on the git changelog.""" - new_changelog = 'ChangeLog' - if not os.getenv('SKIP_WRITE_GIT_CHANGELOG'): - if os.path.isdir('.git'): - git_log_cmd = 'git log --stat' - changelog = _run_shell_command(git_log_cmd) - mailmap = parse_mailmap() - with open(new_changelog, "w") as changelog_file: - changelog_file.write(canonicalize_emails(changelog, mailmap)) - else: - open(new_changelog, 'w').close() - - -def generate_authors(): - """Create AUTHORS file using git commits.""" - jenkins_email = 'jenkins@review.(openstack|stackforge).org' - old_authors = 'AUTHORS.in' - new_authors = 'AUTHORS' - if not os.getenv('SKIP_GENERATE_AUTHORS'): - if os.path.isdir('.git'): - # don't include jenkins email address in AUTHORS file - git_log_cmd = ("git log --format='%aN <%aE>' | sort -u | " - "egrep -v '" + jenkins_email + "'") - changelog = _run_shell_command(git_log_cmd) - mailmap = parse_mailmap() - with open(new_authors, 'w') as new_authors_fh: - new_authors_fh.write(canonicalize_emails(changelog, mailmap)) - if os.path.exists(old_authors): - with open(old_authors, "r") as old_authors_fh: - new_authors_fh.write('\n' + old_authors_fh.read()) - else: - open(new_authors, 'w').close() - - -_rst_template = """%(heading)s -%(underline)s - -.. automodule:: %(module)s - :members: - :undoc-members: - :show-inheritance: -""" - - -def get_cmdclass(): - """Return dict of commands to run from setup.py.""" - - cmdclass = dict() - - def _find_modules(arg, dirname, files): - for filename in files: - if filename.endswith('.py') and filename != '__init__.py': - arg["%s.%s" % (dirname.replace('/', '.'), - filename[:-3])] = True - - class LocalSDist(sdist.sdist): - """Builds the ChangeLog and Authors files from VC first.""" - - def run(self): - write_git_changelog() - generate_authors() - # sdist.sdist is an old style class, can't use super() - sdist.sdist.run(self) - - cmdclass['sdist'] = LocalSDist - - # If Sphinx is installed on the box running setup.py, - # enable setup.py to build the documentation, otherwise, - # just ignore it - try: - from sphinx.setup_command import BuildDoc - - class LocalBuildDoc(BuildDoc): - - builders = ['html', 'man'] - - def generate_autoindex(self): - print "**Autodocumenting from %s" % os.path.abspath(os.curdir) - modules = {} - option_dict = self.distribution.get_option_dict('build_sphinx') - source_dir = os.path.join(option_dict['source_dir'][1], 'api') - if not os.path.exists(source_dir): - os.makedirs(source_dir) - for pkg in self.distribution.packages: - if '.' not in pkg: - os.path.walk(pkg, _find_modules, modules) - module_list = modules.keys() - module_list.sort() - autoindex_filename = os.path.join(source_dir, 'autoindex.rst') - with open(autoindex_filename, 'w') as autoindex: - autoindex.write(""".. toctree:: - :maxdepth: 1 - -""") - for module in module_list: - output_filename = os.path.join(source_dir, - "%s.rst" % module) - heading = "The :mod:`%s` Module" % module - underline = "=" * len(heading) - values = dict(module=module, heading=heading, - underline=underline) - - print "Generating %s" % output_filename - with open(output_filename, 'w') as output_file: - output_file.write(_rst_template % values) - autoindex.write(" %s.rst\n" % module) - - def run(self): - if not os.getenv('SPHINX_DEBUG'): - self.generate_autoindex() - - for builder in self.builders: - self.builder = builder - self.finalize_options() - self.project = self.distribution.get_name() - self.version = self.distribution.get_version() - self.release = self.distribution.get_version() - BuildDoc.run(self) - - class LocalBuildLatex(LocalBuildDoc): - builders = ['latex'] - - cmdclass['build_sphinx'] = LocalBuildDoc - cmdclass['build_sphinx_latex'] = LocalBuildLatex - except ImportError: - pass - - return cmdclass - - -def _get_revno(): - """Return the number of commits since the most recent tag. - - We use git-describe to find this out, but if there are no - tags then we fall back to counting commits since the beginning - of time. - """ - describe = _run_shell_command("git describe --always") - if "-" in describe: - return describe.rsplit("-", 2)[-2] - - # no tags found - revlist = _run_shell_command("git rev-list --abbrev-commit HEAD") - return len(revlist.splitlines()) - - -def get_version_from_git(pre_version): - """Return a version which is equal to the tag that's on the current - revision if there is one, or tag plus number of additional revisions - if the current revision has no tag.""" - - if os.path.isdir('.git'): - if pre_version: - try: - return _run_shell_command( - "git describe --exact-match", - throw_on_error=True).replace('-', '.') - except Exception: - sha = _run_shell_command("git log -n1 --pretty=format:%h") - return "%s.a%s.g%s" % (pre_version, _get_revno(), sha) - else: - return _run_shell_command( - "git describe --always").replace('-', '.') - return None - - -def get_version_from_pkg_info(package_name): - """Get the version from PKG-INFO file if we can.""" - try: - pkg_info_file = open('PKG-INFO', 'r') - except (IOError, OSError): - return None - try: - pkg_info = email.message_from_file(pkg_info_file) - except email.MessageError: - return None - # Check to make sure we're in our own dir - if pkg_info.get('Name', None) != package_name: - return None - return pkg_info.get('Version', None) - - -def get_version(package_name, pre_version=None): - """Get the version of the project. First, try getting it from PKG-INFO, if - it exists. If it does, that means we're in a distribution tarball or that - install has happened. Otherwise, if there is no PKG-INFO file, pull the - version from git. - - We do not support setup.py version sanity in git archive tarballs, nor do - we support packagers directly sucking our git repo into theirs. We expect - that a source tarball be made from our git repo - or that if someone wants - to make a source tarball from a fork of our repo with additional tags in it - that they understand and desire the results of doing that. - """ - version = os.environ.get("OSLO_PACKAGE_VERSION", None) - if version: - return version - version = get_version_from_pkg_info(package_name) - if version: - return version - version = get_version_from_git(pre_version) - if version: - return version - raise Exception("Versioning for this project requires either an sdist" - " tarball, or access to an upstream git repository.") diff --git a/monikerclient/openstack/common/version.py b/monikerclient/openstack/common/version.py deleted file mode 100644 index 3653ad0d..00000000 --- a/monikerclient/openstack/common/version.py +++ /dev/null @@ -1,79 +0,0 @@ - -# Copyright 2012 OpenStack LLC -# Copyright 2012-2013 Hewlett-Packard Development Company, L.P. -# -# 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. - -""" -Utilities for consuming the version from pkg_resources. -""" - -import pkg_resources - - -class VersionInfo(object): - - def __init__(self, package): - """Object that understands versioning for a package - :param package: name of the python package, such as glance, or - python-glanceclient - """ - self.package = package - self.release = None - self.version = None - self._cached_version = None - - def _get_version_from_pkg_resources(self): - """Get the version of the package from the pkg_resources record - associated with the package.""" - requirement = pkg_resources.Requirement.parse(self.package) - provider = pkg_resources.get_provider(requirement) - return provider.version - - def release_string(self): - """Return the full version of the package including suffixes indicating - VCS status. - """ - if self.release is None: - self.release = self._get_version_from_pkg_resources() - - return self.release - - def version_string(self): - """Return the short version minus any alpha/beta tags.""" - if self.version is None: - parts = [] - for part in self.release_string().split('.'): - if part[0].isdigit(): - parts.append(part) - else: - break - self.version = ".".join(parts) - - return self.version - - # Compatibility functions - canonical_version_string = version_string - version_string_with_vcs = release_string - - def cached_version_string(self, prefix=""): - """Generate an object which will expand in a string context to - the results of version_string(). We do this so that don't - call into pkg_resources every time we start up a program when - passing version information into the CONF constructor, but - rather only do the calculation when and if a version is requested - """ - if not self._cached_version: - self._cached_version = "%s%s" % (prefix, - self.version_string()) - return self._cached_version diff --git a/monikerclient/version.py b/monikerclient/version.py index ecfb3a9f..fd80506a 100644 --- a/monikerclient/version.py +++ b/monikerclient/version.py @@ -13,6 +13,6 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. -from monikerclient.openstack.common import version as common_version +import pbr.version -version_info = common_version.VersionInfo('python-monikerclient') +version_info = pbr.version.VersionInfo('python-monikerclient') diff --git a/openstack-common.conf b/openstack-common.conf deleted file mode 100644 index 1ebaec11..00000000 --- a/openstack-common.conf +++ /dev/null @@ -1,3 +0,0 @@ -[DEFAULT] -modules=setup,version -base=monikerclient diff --git a/tools/pip-requires b/requirements.txt similarity index 75% rename from tools/pip-requires rename to requirements.txt index a358dc05..bc4465ef 100644 --- a/tools/pip-requires +++ b/requirements.txt @@ -1,3 +1,5 @@ +d2to1>=0.2.10,<0.3 +pbr>=0.5,<0.6 cliff>=1.2.1 jsonschema>=0.8,<1 stevedore diff --git a/setup.cfg b/setup.cfg index f0188f04..5beea60e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,16 +1,94 @@ -[nosetests] -cover-package=monikerclient -cover-html=true -cover-erase=true -cover-inclusive=true -verbosity=2 -detailed-errors=1 -where=monikerclient/tests +[metadata] +name = python-monikerclient +version = 2013.1 +summary = DNS as a Service - Client +description-file = + README.rst +author = Kiall Mac Innes +author-email = kiall@managedit.ie +home-page = https://launchpad.net/python-monikerclientclient +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 2.6 + Topic :: Internet :: Name Service (DNS) + +[global] +setup-hooks = + pbr.hooks.setup_hook + +[files] +packages = + monikerclient +scripts = + bin/moniker + +[entry_points] +monikerclient.v1.controllers = + reports = monikerclient.v1.reports:ReportsController + diagnostics = monikerclient.v1.diagnostics:DiagnosticsController + domains = monikerclient.v1.domains:DomainsController + records = monikerclient.v1.records:RecordsController + servers = monikerclient.v1.servers:ServersController + +monikerclient.cli = + domain-list = monikerclient.cli.domains:ListDomainsCommand + domain-get = monikerclient.cli.domains:GetDomainCommand + domain-create = monikerclient.cli.domains:CreateDomainCommand + domain-update = monikerclient.cli.domains:UpdateDomainCommand + domain-delete = monikerclient.cli.domains:DeleteDomainCommand + domain-servers-list = monikerclient.cli.domains:ListDomainServersCommand + + record-list = monikerclient.cli.records:ListRecordsCommand + record-get = monikerclient.cli.records:GetRecordCommand + record-create = monikerclient.cli.records:CreateRecordCommand + record-update = monikerclient.cli.records:UpdateRecordCommand + record-delete = monikerclient.cli.records:DeleteRecordCommand + + server-list = monikerclient.cli.servers:ListServersCommand + server-get = monikerclient.cli.servers:GetServerCommand + server-create = monikerclient.cli.servers:CreateServerCommand + server-update = monikerclient.cli.servers:UpdateServerCommand + server-delete = monikerclient.cli.servers:DeleteServerCommand + + diagnostics-ping = monikerclient.cli.diagnostics:PingCommand + diagnostics-sync-all = monikerclient.cli.diagnostics:SyncAllCommand + diagnostics-sync-domain = monikerclient.cli.diagnostics:SyncDomainCommand + diagnostics-sync-record = monikerclient.cli.diagnostics:SyncRecordCommand + + report-count-all = monikerclient.cli.reports:CountsCommand + report-count-domains = monikerclient.cli.reports:DomainCountCommand + report-count-records = monikerclient.cli.reports:RecordCountCommand + report-count-tenants = monikerclient.cli.reports:TenantCountCommand + report-tenants-all = monikerclient.cli.reports:TenantsCommand + report-tenant-domains = monikerclient.cli.reports:TenantCommand [build_sphinx] +all_files = 1 +build-dir = doc/build source-dir = doc/source -build-dir = doc/build -all_files = 1 -[upload_docs] -upload-dir = doc/build/html +[egg_info] +tag_build = +tag_date = 0 +tag_svn_revision = 0 + +[compile_catalog] +directory = monikerclient/locale +domain = monikerclient + +[update_catalog] +domain = monikerclient +output_dir = monikerclient/locale +input_file = monikerclient/locale/monikerclient.pot + +[extract_messages] +keywords = _ gettext ngettext l_ lazy_gettext +mapping_file = babel.cfg +output_file = monikerclient/locale/monikerclient.pot diff --git a/setup.py b/setup.py index 0f28bc3b..25702851 100755 --- a/setup.py +++ b/setup.py @@ -14,89 +14,8 @@ # 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 textwrap -from setuptools import setup, find_packages -from monikerclient.openstack.common import setup as common_setup +import setuptools -install_requires = common_setup.parse_requirements(['tools/pip-requires']) -tests_require = common_setup.parse_requirements(['tools/test-requires']) -setup_require = common_setup.parse_requirements(['tools/setup-requires']) -dependency_links = common_setup.parse_dependency_links([ - 'tools/pip-requires', - 'tools/test-requires', - 'tools/setup-requires' -]) - -setup( - name='python-monikerclient', - version=common_setup.get_version('python-monikerclient'), - description='DNS as a Service - Client', - author='Kiall Mac Innes', - author_email='kiall@managedit.ie', - url='https://launchpad.net/python-monikerclient', - packages=find_packages(exclude=['bin']), - include_package_data=True, - test_suite='nose.collector', - setup_requires=setup_require, - install_requires=install_requires, - tests_require=tests_require, - extras_require={'test': tests_require}, - dependency_links=dependency_links, - scripts=[ - 'bin/moniker', - ], - cmdclass=common_setup.get_cmdclass(), - entry_points=textwrap.dedent(""" - [monikerclient.v1.controllers] - reports = monikerclient.v1.reports:ReportsController - diagnostics = monikerclient.v1.diagnostics:DiagnosticsController - domains = monikerclient.v1.domains:DomainsController - records = monikerclient.v1.records:RecordsController - servers = monikerclient.v1.servers:ServersController - - [monikerclient.cli] - domain-list = monikerclient.cli.domains:ListDomainsCommand - domain-get = monikerclient.cli.domains:GetDomainCommand - domain-create = monikerclient.cli.domains:CreateDomainCommand - domain-update = monikerclient.cli.domains:UpdateDomainCommand - domain-delete = monikerclient.cli.domains:DeleteDomainCommand - domain-servers-list = monikerclient.cli.domains\ - :ListDomainServersCommand - - record-list = monikerclient.cli.records:ListRecordsCommand - record-get = monikerclient.cli.records:GetRecordCommand - record-create = monikerclient.cli.records:CreateRecordCommand - record-update = monikerclient.cli.records:UpdateRecordCommand - record-delete = monikerclient.cli.records:DeleteRecordCommand - - server-list = monikerclient.cli.servers:ListServersCommand - server-get = monikerclient.cli.servers:GetServerCommand - server-create = monikerclient.cli.servers:CreateServerCommand - server-update = monikerclient.cli.servers:UpdateServerCommand - server-delete = monikerclient.cli.servers:DeleteServerCommand - - diagnostics-ping = monikerclient.cli.diagnostics:PingCommand - diagnostics-sync-all = monikerclient.cli.diagnostics:SyncAllCommand - diagnostics-sync-domain = monikerclient.cli.diagnostics\ - :SyncDomainCommand - diagnostics-sync-record = monikerclient.cli.diagnostics\ - :SyncRecordCommand - - report-count-all = monikerclient.cli.reports:CountsCommand - report-count-domains = monikerclient.cli.reports:DomainCountCommand - report-count-records = monikerclient.cli.reports:RecordCountCommand - report-count-tenants = monikerclient.cli.reports:TenantCountCommand - report-tenants-all = monikerclient.cli.reports:TenantsCommand - report-tenant-domains = monikerclient.cli.reports:TenantCommand - """), - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Topic :: Internet :: Name Service (DNS)', - 'License :: OSI Approved :: Apache Software License', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 2.6', - 'Programming Language :: Python :: 2.7', - 'Environment :: Console', - 'Environment :: OpenStack', - ], -) +setuptools.setup( + setup_requires=['d2to1', 'pbr'], + d2to1=True) diff --git a/tools/test-requires b/test-requirements.txt similarity index 64% rename from tools/test-requires rename to test-requirements.txt index c728a456..ed753e88 100644 --- a/tools/test-requires +++ b/test-requirements.txt @@ -1,7 +1,5 @@ flake8 -nose mox -openstack.nose_plugin python-subunit sphinx testrepository diff --git a/tools/setup-requires b/tools/setup-requires deleted file mode 100644 index e69de29b..00000000 diff --git a/tox.ini b/tox.ini index 0b75652f..010130b0 100644 --- a/tox.ini +++ b/tox.ini @@ -7,9 +7,8 @@ setenv = VIRTUAL_ENV={envdir} LANG=en_US.UTF-8 LANGUAGE=en_US:en LC_ALL=C -deps = -r{toxinidir}/tools/setup-requires - -r{toxinidir}/tools/pip-requires - -r{toxinidir}/tools/test-requires +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt commands = python setup.py testr --testr-args='{posargs}' sitepackages = False