From c9db5c36222d1b13acf6eae35c9f4f3ad090e41f Mon Sep 17 00:00:00 2001 From: Jakub Ruzicka Date: Mon, 2 Nov 2015 09:04:29 +0100 Subject: [PATCH] Initial import Change-Id: Iae6954b555e948c87bde79781ec07bd8c24f9554 --- LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 2 + Makefile | 22 ++++++ README.md | 60 +++++++++++++++ pymod2pkg.py | 128 ++++++++++++++++++++++++++++++++ setup.py | 32 ++++++++ tests.py | 56 ++++++++++++++ 7 files changed, 502 insertions(+) create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 Makefile create mode 100644 README.md create mode 100644 pymod2pkg.py create mode 100644 setup.py create mode 100644 tests.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e06d208 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..04f196a --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include README.md +include LICENSE diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..7ab8780 --- /dev/null +++ b/Makefile @@ -0,0 +1,22 @@ +NAME = python-pymod2pkg +RPM_DIRS = --define "_sourcedir `pwd`/dist" \ + --define "_rpmdir `pwd`/dist" \ + --define "_specdir `pwd`" \ + --define "_builddir `pwd`/dist" \ + --define "_srcrpmdir `pwd`/dist" + +all: srpm + +dist: + python setup.py sdist + +clean: + rm -rf dist/ pymod2pkg.egg-info pymod2pkg.pyc + +rpm: dist $(NAME).spec + rpmbuild $(RPM_DIRS) -ba $(NAME).spec + +srpm: dist $(NAME).spec + rpmbuild $(RPM_DIRS) -bs $(NAME).spec + +.PHONY: clean dist rpm srpm diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e93ba9 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +#: pymod2pkg + +`pymod2pkg` is a simple python module for translating python module names to +corresponding package names which is a common problem in the packaging world. + +Note that [rdopkg](https://github.com/redhat-openstack/rdopkg) uses this +module to check whether packages corresponding to `requirements.txt` are +available across distros and more. + + +## Installation + + +### from source + +If you want to hack `pymod2pkg` or just have the latest version without +waiting for next release, I suggest using the git repo directly a la + + git clone https://github.com/openstack/pymod2pkg + cd pymod2pkg + python setup.py develop --user + + +### from PyPI + +For your convenience, `pymod2pkg` is also available from the Cheese +Shop: + + pip install pymod2pkg + + + +## Usage + +`module2package` is probably all you need, it accepts a module name to convert +and a linux distribution name as returned by `platform.linux_distribution()[0]`: + + import pymod2pkg + + pkg = pymod2pkg.module2package('six', 'Fedora') + +There's not much more, really, so RTFS. + + + +## Fixing/extending the map + +Currently, only package maps for RPM-based systems are provided, but it'd be +nice to have all the distros covered and it's really easy to do. + +See `*_PKG_MAP` and `get_pkg_map`, hack it to your liking and submit review by + + git review + + +## Running the testsuite + +Run tests by: + + python tests.py diff --git a/pymod2pkg.py b/pymod2pkg.py new file mode 100644 index 0000000..adb8759 --- /dev/null +++ b/pymod2pkg.py @@ -0,0 +1,128 @@ +import re + + +__version__ = '0.2.1' + + +class TranslationRule(object): + pass + + +class SingleRule(TranslationRule): + def __init__(self, mod, pkg, distmap=None): + self.mod = mod + self.pkg = pkg + self.distmap = distmap + + def __call__(self, mod, dist): + if mod != self.mod: + return None + if self.distmap and dist: + for distrex in self.distmap: + if re.match(distrex, dist): + return self.distmap[distrex] + return self.pkg + + +class MultiRule(TranslationRule): + def __init__(self, mods, pkgfun): + self.mods = mods + self.pkgfun = pkgfun + + def __call__(self, mod, dist): + if mod in self.mods: + return self.pkgfun(mod) + return None + + +def default_rdo_tr(mod): + pkg = mod.rsplit('-python')[0] + pkg = pkg.replace('_', '-').replace('.', '-').lower() + if not pkg.startswith('python-'): + pkg = 'python-' + pkg + return pkg + + +def default_suse_tr(mod): + return 'python-' + mod + + +def openstack_prefix_tr(mod): + return 'openstack-' + mod + + +RDO_PKG_MAP = [ + # This demonstrates per-dist filter + #SingleRule('sphinx', 'python-sphinx', + # distmap={'epel-6': 'python-sphinx10'}), + SingleRule('distribute', 'python-setuptools'), + SingleRule('pyopenssl', 'pyOpenSSL'), + SingleRule('IPy', 'python-IPy'), + SingleRule('pycrypto', 'python-crypto'), + SingleRule('pyzmq', 'python-zmq'), + SingleRule('mysql-python', 'MySQL-python'), + SingleRule('PasteDeploy', 'python-paste-deploy'), + SingleRule('sqlalchemy-migrate', 'python-migrate'), + SingleRule('qpid-python', 'python-qpid'), + SingleRule('posix_ipc', 'python-posix_ipc'), + SingleRule('oslosphinx', 'python-oslo-sphinx'), + MultiRule( + mods=['PyYAML', 'm2crypto', 'numpy', 'pyflakes', 'pylint', 'pyparsing', + 'pytz', 'pysendfile', 'libvirt-python'], + pkgfun=lambda x: x), + MultiRule( + mods=['nova', 'keystone', 'glance', 'swift', 'neutron'], + pkgfun=openstack_prefix_tr), +] + + +SUSE_PKG_MAP = [ + # OpenStack services + MultiRule( + # keep lists in alphabetic order + mods=['ceilometer', 'cinder', 'designate', 'glance', + 'heat', 'ironic', 'keystone', 'manila', + 'neutron', 'nova', 'rally', 'sahara', 'swift', + 'tempest', 'trove', 'tuskar', 'zaqar'], + pkgfun=openstack_prefix_tr), + # OpenStack clients + MultiRule( + mods=['python-ceilometerclient', 'python-cinderclient', + 'python-designateclient', 'python-glanceclient', + 'python-heatclient', 'python-ironicclient', + 'python-keystoneclient', 'python-manilaclient', + 'python-neutronclient', 'python-novaclient', + 'python-saharaclient', 'python-swiftclient', + 'python-troveclient', 'python-tuskarclient', + 'python-zaqarclient'], + pkgfun=lambda x: x), +] + + +def get_pkg_map(dist): + if dist.lower().find('suse') != -1: + return SUSE_PKG_MAP + return RDO_PKG_MAP + + +def get_default_tr_func(dist): + if dist.lower().find('suse') != -1: + return default_suse_tr + return default_rdo_tr + + +def module2package(mod, dist, pkg_map=None): + """Return a corresponding package name for a python module. + + mod -- python module name + dist -- a linux distribution as returned by + `platform.linux_distribution()[0]` + """ + if not pkg_map: + pkg_map = get_pkg_map(dist) + for rule in pkg_map: + pkg = rule(mod, dist) + if pkg: + return pkg + tr_func = get_default_tr_func(dist) + return tr_func(mod) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..13c4701 --- /dev/null +++ b/setup.py @@ -0,0 +1,32 @@ +from __future__ import with_statement + +try: + from setuptools import setup +except ImportError: + from distutils.core import setup + +import pymod2pkg + +pymod2pkg_classifiers = [ + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 3", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Topic :: Software Development :: Libraries", + "Topic :: Utilities", +] + +with open("README.md", "r") as fp: + pymod2pkg_long_description = fp.read() + +setup(name="pymod2pkg", + version=pymod2pkg.__version__, + author="Jakub Ruzicka", + author_email="jruzicka@fedorapeople.org", + url="https://github.com/openstack/pymod2pkg", + py_modules=["pymod2pkg"], + description="python module name to package name map", + long_description=pymod2pkg_long_description, + classifiers=pymod2pkg_classifiers, + license="Apache License, Version 2.0", + ) diff --git a/tests.py b/tests.py new file mode 100644 index 0000000..91f75b5 --- /dev/null +++ b/tests.py @@ -0,0 +1,56 @@ +#!/usr/bin/env python +# +# Copyright 2015 SUSE Linux GmbH +# +# 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. + +# py26 compat +try: + import unittest2 as unittest +except ImportError: + import unittest + +import pymod2pkg + + +class Pymod2PkgTests(unittest.TestCase): + def test_get_default_translation_func(self): + self.assertEqual(pymod2pkg.get_default_tr_func('suse'), + pymod2pkg.default_suse_tr) + self.assertEqual(pymod2pkg.get_default_tr_func('anything'), + pymod2pkg.default_rdo_tr) + + def test_default_translation_suse(self): + self.assertEqual(pymod2pkg.module2package('oslo.db', 'suse'), + 'python-oslo.db') + self.assertEqual(pymod2pkg.module2package('Babel', 'suse'), + 'python-Babel') + + def test_translation_suse(self): + self.assertEqual(pymod2pkg.module2package('nova', 'suse'), + 'openstack-nova') + self.assertEqual(pymod2pkg.module2package('python-neutronclient', + 'suse'), + 'python-neutronclient') + + def test_default_translation_rdo(self): + self.assertEqual(pymod2pkg.module2package('oslo.db', 'fedora'), + 'python-oslo-db') + self.assertEqual(pymod2pkg.module2package('Babel', 'fedora'), + 'python-babel') + self.assertEqual(pymod2pkg.module2package('nova', 'fedora'), + 'openstack-nova') + + +if __name__ == '__main__': + unittest.main()