setup.py

#!/usr/bin/env python3
"""
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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
from os.path import dirname
from setuptools import find_packages, setup

AMBARI_COMMON_PYTHON_FOLDER = "ambari-common/src/main/python"
AMBARI_SERVER_TEST_PYTHON_FOLDER = "ambari-server/src/test/python"
AMBARI_COMMON_TEST_PYTHON_FOLDER = "ambari-common/src/test/python"


def get_ambari_common_packages():
  return find_packages(
    AMBARI_COMMON_PYTHON_FOLDER, exclude=["*.tests", "*.tests.*", "tests.*", "tests"]
  )


def get_ambari_server_stack_package():
  return ["stacks.utils"]


def get_extra_common_packages():
  return [
    "urlinfo_processor",
    "ambari_jinja2",
    "ambari_jinja2._markupsafe",
    "mock",
    "mock.test",
  ]


def create_package_dir_map():
  package_dirs = {}
  ambari_common_packages = get_ambari_common_packages()
  for ambari_common_package in ambari_common_packages:
    package_dirs[ambari_common_package] = (
      AMBARI_COMMON_PYTHON_FOLDER + "/" + ambari_common_package.replace(".", "/")
    )

  ambari_server_packages = get_ambari_server_stack_package()
  for ambari_server_package in ambari_server_packages:
    package_dirs[ambari_server_package] = (
      AMBARI_SERVER_TEST_PYTHON_FOLDER + "/" + ambari_server_package.replace(".", "/")
    )
  package_dirs["ambari_jinja2"] = (
    AMBARI_COMMON_PYTHON_FOLDER + "/ambari_jinja2/ambari_jinja2"
  )
  package_dirs["ambari_jinja2._markupsafe"] = (
    AMBARI_COMMON_PYTHON_FOLDER + "/ambari_jinja2/ambari_jinja2/_markupsafe"
  )
  package_dirs["urlinfo_processor"] = AMBARI_COMMON_PYTHON_FOLDER + "/urlinfo_processor"
  package_dirs["mock"] = AMBARI_COMMON_TEST_PYTHON_FOLDER + "/mock"
  package_dirs["mock.test"] = AMBARI_COMMON_TEST_PYTHON_FOLDER + "/mock/tests"

  return package_dirs


__version__ = "3.1.0.0-SNAPSHOT"


def get_version():
  """
  Obtain ambari version during the build from pom.xml, which will be stored in PKG-INFO file.
  During installation from pip, pom.xml is not included in the distribution but PKG-INFO is, so it can be used
  instead of pom.xml file. If for some reason both are not exists use the default __version__ variable.
  All of these can be overridden by AMBARI_VERSION environment variable.
  """
  base_dir = dirname(__file__)
  if "AMBARI_VERSION" in os.environ:
    return os.environ["AMBARI_VERSION"]
  elif os.path.exists(os.path.join(base_dir, "pom.xml")):
    from xml.etree import ElementTree as et

    ns = "http://maven.apache.org/POM/4.0.0"
    et.register_namespace("", ns)
    tree = et.ElementTree()
    tree.parse(os.path.join(base_dir, "pom.xml"))
    parent_version_tag = tree.getroot().find("{%s}version" % ns)
    return parent_version_tag.text if parent_version_tag is not None else __version__
  elif os.path.exists(os.path.join(base_dir, "PKG-INFO")):
    import re

    version = None
    version_re = re.compile("^Version: (.+)$", re.M)
    with open(os.path.join(base_dir, "PKG-INFO")) as f:
      version = version_re.search(f.read()).group(1)
    return version if version is not None else __version__
  else:
    return __version__


"""
Example usage:
- build package with specific version:
  python setup.py sdist -d "my/dist/location"
- build and install package with specific version:
  python setup.py sdist -d "my/dist/location" install
- build and upload package with specific version:
  python setup.py sdist -d "my/dist/location" upload -r "http://localhost:8080"

Installing from pip:
- pip install --extra-index-url=http://localhost:8080 ambari-python==2.7.1.0  // 3.0.0.0-SNAPSHOT is the snapshot version
"""
setup(
  name="ambari-python",
  version=get_version(),
  author="Apache Software Foundation",
  author_email="dev@ambari.apache.org",
  description=("Framework for provison/manage/monitor Hadoop clusters"),
  license="AP2",
  keywords="hadoop, ambari",
  url="https://ambari.apache.org",
  packages=get_ambari_common_packages()
  + get_ambari_server_stack_package()
  + get_extra_common_packages(),
  package_dir=create_package_dir_map(),
  install_requires=["coilmq==1.0.1"],
  include_package_data=True,
  long_description="The Apache Ambari project is aimed at making Hadoop management simpler by developing software for provisioning, managing, and monitoring Apache Hadoop clusters. "
  "Ambari provides an intuitive, easy-to-use Hadoop management web UI backed by its RESTful APIs.",
)