diff --git a/.gitignore b/.gitignore index 0558c26b..aacc5cd5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +AUTHORS +ChangeLog +dist/ +.tox *.egg-info *.py[co] .DS_Store diff --git a/.gitreview b/.gitreview new file mode 100644 index 00000000..0387a741 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/python-swiftclient.git diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 91603d12..00000000 --- a/AUTHORS +++ /dev/null @@ -1,19 +0,0 @@ -Anne Gentle -Chmouel Boudjnah -Chuck Thier -Clay Gerrard -David Goetz -Dean Troyer -Donagh McCabe -Doug Weimer -Dragos Manolescu -Eamonn O'Toole -Felipe Reyes -Greg Holt -Jay Payne -John Dickinson -Julien Danjou -Marcelo Martins -Monty Taylor -Pete Zaitcev -Thierry Carrez diff --git a/CHANGELOG b/CHANGELOG deleted file mode 100644 index 365dc1a9..00000000 --- a/CHANGELOG +++ /dev/null @@ -1,4 +0,0 @@ -- Chmouel Boudjnah - - * 1.0: - Initial separation release diff --git a/MANIFEST.in b/MANIFEST.in index 6742c856..f2ddd1b6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,5 @@ -include README.rst +include AUTHORS +include ChangeLog include LICENSE +include README.rst recursive-include tests * diff --git a/openstack-common.conf b/openstack-common.conf new file mode 100644 index 00000000..d3694ce9 --- /dev/null +++ b/openstack-common.conf @@ -0,0 +1,7 @@ +[DEFAULT] + +# The list of modules to copy from openstack-common +modules=setup + +# The base module to hold the copy of openstack.common +base=swiftclient diff --git a/setup.py b/setup.py index 926e142c..6b2818fd 100644 --- a/setup.py +++ b/setup.py @@ -1,32 +1,51 @@ +#!/usr/bin/python # -*- encoding: utf-8 -*- +# Copyright (c) 2010 OpenStack, LLC. +# +# 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. + import os import setuptools import sys -# TODO: Figuring out how we are going to do the versionning (and if +from swiftclient.openstack.common import setup + +# TODO: Figuring out how we are going to do the versioning (and if # any). version = '1.0' name = 'python-swiftclient' -requires = [] + +requires = setup.parse_requirements() +depend_links = setup.parse_dependency_links() def read(fname): return open(os.path.join(os.path.dirname(__file__), fname)).read() -if sys.version_info < (2, 6): - requires.append('simplejson') - setuptools.setup( name=name, version=version, description='Client Library for OpenStack Object Storage API', long_description=read('README.rst'), - url='https://github.com/chmouel/python-swiftclient', + url='https://github.com/openstack/python-swiftclient', license='Apache License (2.0)', author='OpenStack, LLC.', author_email='openstack-admins@lists.launchpad.net', packages=setuptools.find_packages(exclude=['tests', 'tests.*']), + cmdclass=setup.get_cmdclass(), install_requires=requires, + dependency_links=depend_links, classifiers=[ 'Development Status :: 4 - Beta', 'Environment :: Console', diff --git a/swiftclient/openstack/__init__.py b/swiftclient/openstack/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/swiftclient/openstack/common/__init__.py b/swiftclient/openstack/common/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/swiftclient/openstack/common/setup.py b/swiftclient/openstack/common/setup.py new file mode 100644 index 00000000..40178903 --- /dev/null +++ b/swiftclient/openstack/common/setup.py @@ -0,0 +1,183 @@ +# vim: tabstop=4 shiftwidth=4 softtabstop=4 + +# Copyright 2011 OpenStack LLC. +# 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 os +import re +import subprocess + +from setuptools.command import sdist + + +def parse_mailmap(mailmap='.mailmap'): + mapping = {} + if os.path.exists(mailmap): + fp = open(mailmap, 'r') + for l in fp: + l = l.strip() + if not l.startswith('#') and ' ' in l: + canonical_email, alias = [x for x in l.split(' ') \ + if x.startswith('<')] + 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 in mapping.iteritems(): + changelog = changelog.replace(alias, email) + return changelog + + +# Get requirements from the first file that exists +def get_reqs_from_files(requirements_files): + reqs_in = [] + for requirements_file in requirements_files: + if os.path.exists(requirements_file): + return open(requirements_file, 'r').read().split('\n') + return [] + + +def parse_requirements(requirements_files=['requirements.txt', + 'tools/pip-requires']): + requirements = [] + for line in get_reqs_from_files(requirements_files): + if re.match(r'\s*-e\s+', line): + requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1', + line)) + elif re.match(r'\s*-f\s+', line): + pass + else: + requirements.append(line) + + return requirements + + +def parse_dependency_links(requirements_files=['requirements.txt', + 'tools/pip-requires']): + dependency_links = [] + for line in get_reqs_from_files(requirements_files): + if re.match(r'(\s*#)|(\s*$)', line): + continue + if re.match(r'\s*-[ef]\s+', line): + dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line)) + return dependency_links + + +def write_requirements(): + venv = os.environ.get('VIRTUAL_ENV', None) + if venv is not None: + with open("requirements.txt", "w") as req_file: + output = subprocess.Popen(["pip", "-E", venv, "freeze", "-l"], + stdout=subprocess.PIPE) + requirements = output.communicate()[0].strip() + req_file.write(requirements) + + +def _run_shell_command(cmd): + output = subprocess.Popen(["/bin/sh", "-c", cmd], + stdout=subprocess.PIPE) + return output.communicate()[0].strip() + + +def write_vcsversion(location): + """Produce a vcsversion dict that mimics the old one produced by bzr. + """ + if os.path.isdir('.git'): + branch_nick_cmd = 'git branch | grep -Ei "\* (.*)" | cut -f2 -d" "' + branch_nick = _run_shell_command(branch_nick_cmd) + revid_cmd = "git rev-parse HEAD" + revid = _run_shell_command(revid_cmd).split()[0] + revno_cmd = "git log --oneline | wc -l" + revno = _run_shell_command(revno_cmd) + with open(location, 'w') as version_file: + version_file.write(""" +# This file is automatically generated by setup.py, So don't edit it. :) +version_info = { + 'branch_nick': '%s', + 'revision_id': '%s', + 'revno': %s +} +""" % (branch_nick, revid, revno)) + + +def write_git_changelog(): + """Write a changelog based on the 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("ChangeLog", "w") as changelog_file: + changelog_file.write(canonicalize_emails(changelog, mailmap)) + + +def generate_authors(): + """Create AUTHORS file using git commits.""" + jenkins_email = 'jenkins@review.openstack.org' + old_authors = 'AUTHORS.in' + new_authors = '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 | " \ + "grep -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()) + + +def get_cmdclass(): + """Return dict of commands to run from setup.py.""" + + cmdclass = dict() + + 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): + def run(self): + for builder in ['html', 'man']: + self.builder = builder + self.finalize_options() + BuildDoc.run(self) + cmdclass['build_sphinx'] = LocalBuildDoc + except ImportError: + pass + + return cmdclass diff --git a/tools/pip-requires b/tools/pip-requires new file mode 100644 index 00000000..322630ee --- /dev/null +++ b/tools/pip-requires @@ -0,0 +1 @@ +simplejson diff --git a/tools/test-requires b/tools/test-requires new file mode 100644 index 00000000..79a5a83f --- /dev/null +++ b/tools/test-requires @@ -0,0 +1,8 @@ +distribute>=0.6.24 + +nose +nose-exclude +nosexcover +openstack.nose_plugin +pep8>=1.0 +sphinx>=1.1.2 diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..4698ad79 --- /dev/null +++ b/tox.ini @@ -0,0 +1,46 @@ +[tox] +envlist = py26,py27,pep8 + +[testenv] +setenv = VIRTUAL_ENV={envdir} + NOSE_WITH_OPENSTACK=1 + NOSE_OPENSTACK_COLOR=1 + NOSE_OPENSTACK_RED=0.05 + NOSE_OPENSTACK_YELLOW=0.025 + NOSE_OPENSTACK_SHOW_ELAPSED=1 +deps = -r{toxinidir}/tools/pip-requires + -r{toxinidir}/tools/test-requires +commands = nosetests + +[testenv:pep8] +deps = pep8 +commands = pep8 --repeat --show-source swiftclient setup.py + +[testenv:venv] +commands = {posargs} + +[testenv:cover] +commands = nosetests --cover-erase --cover-package=swiftclient --with-xcoverage + +[tox:jenkins] +downloadcache = ~/cache/pip + +[testenv:jenkins26] +basepython = python2.6 +setenv = NOSE_WITH_XUNIT=1 +deps = file://{toxinidir}/.cache.bundle + +[testenv:jenkins27] +basepython = python2.7 +setenv = NOSE_WITH_XUNIT=1 +deps = file://{toxinidir}/.cache.bundle + +[testenv:jenkinscover] +deps = file://{toxinidir}/.cache.bundle +setenv = NOSE_WITH_XUNIT=1 +commands = nosetests --cover-erase --cover-package=swiftclient --with-xcoverage + +[testenv:jenkinsvenv] +deps = file://{toxinidir}/.cache.bundle +setenv = NOSE_WITH_XUNIT=1 +commands = {posargs}