From 246d0623f883317ce8dea613fb24ecbe862742b9 Mon Sep 17 00:00:00 2001 From: Jay Zhang Date: Wed, 13 Mar 2019 14:04:34 -0400 Subject: [PATCH] Rename package name to ubiconfig mix up repo name and package name --- README.md | 12 ++++++------ docs/index.rst | 10 +++++----- setup.py | 12 ++++++------ .../config_types/test_config_types.py | 2 +- tests/{ubi_config => ubiconfig}/test_ubi.py | 10 +++++----- .../utils/test_gitlab_api.py | 2 +- .../utils/test_validation.py | 2 +- tox.ini | 6 +++--- ubi_config/__init__.py | 3 --- ubiconfig/__init__.py | 3 +++ {ubi_config => ubiconfig}/config_types/__init__.py | 0 .../config_types/content_sets.py | 0 {ubi_config => ubiconfig}/config_types/modules.py | 0 {ubi_config => ubiconfig}/config_types/packages.py | 0 {ubi_config => ubiconfig}/ubi.py | 2 +- {ubi_config => ubiconfig}/utils/__init__.py | 0 {ubi_config => ubiconfig}/utils/api/__init__.py | 0 {ubi_config => ubiconfig}/utils/api/gitlab.py | 0 {ubi_config => ubiconfig}/utils/config_schema.json | 0 {ubi_config => ubiconfig}/utils/config_validation.py | 0 20 files changed, 32 insertions(+), 32 deletions(-) rename tests/{ubi_config => ubiconfig}/config_types/test_config_types.py (97%) rename tests/{ubi_config => ubiconfig}/test_ubi.py (96%) rename tests/{ubi_config => ubiconfig}/utils/test_gitlab_api.py (97%) rename tests/{ubi_config => ubiconfig}/utils/test_validation.py (86%) delete mode 100644 ubi_config/__init__.py create mode 100644 ubiconfig/__init__.py rename {ubi_config => ubiconfig}/config_types/__init__.py (100%) rename {ubi_config => ubiconfig}/config_types/content_sets.py (100%) rename {ubi_config => ubiconfig}/config_types/modules.py (100%) rename {ubi_config => ubiconfig}/config_types/packages.py (100%) rename {ubi_config => ubiconfig}/ubi.py (99%) rename {ubi_config => ubiconfig}/utils/__init__.py (100%) rename {ubi_config => ubiconfig}/utils/api/__init__.py (100%) rename {ubi_config => ubiconfig}/utils/api/gitlab.py (100%) rename {ubi_config => ubiconfig}/utils/config_schema.json (100%) rename {ubi_config => ubiconfig}/utils/config_validation.py (100%) diff --git a/README.md b/README.md index 25a3857..fb9365d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -python-ubi-config -================== +ubiconfig +========= -A Python library for reading UBI configurations +A Python library for accessing Universal Base Image configurations [![Build Status](https://travis-ci.org/release-engineering/ubi-config.svg?branch=master)](https://travis-ci.org/release-engineering/ubi-config) [![Coverage Status](https://coveralls.io/repos/github/release-engineering/ubi-config/badge.svg?branch=master)](https://coveralls.io/github/release-engineering/ubi-config?branch=master) @@ -26,7 +26,7 @@ When there is `DEFAULT_UBI_REPO` set, user can load the config by passing the co name to `get_loader().load()` ```python -from ubi_config import get_loader +from ubiconfig import get_loader config = get_loader().load('rhel-8-for-x86_64-appstream') # config has been validated and is now a Python object with relevant properties @@ -36,14 +36,14 @@ print package_whitelist Or, get all config files from the repo: ```python -from ubi_config import get_loader +from ubiconfig import get_loader configs = get_loader().load_all() # returns a list of UbiConfig objects ``` Or, user can also load the config from local file: ```python -from ubi_config import get_loader +from ubiconfig import get_loader config = get_loader(local=True).load('/path/to/rhel-8-for-x86_64-appstream.yaml') ``` diff --git a/docs/index.rst b/docs/index.rst index 8ce872f..a72caec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,7 @@ No matter which branch is the config file in, it will load it for you. .. code-block:: python - from ubi_config import get_loader + from ubiconfig import get_loader default_loader = get_loader() config = default_loader.load("ubi7_config_file") @@ -58,7 +58,7 @@ Except the above usage, there are some other use cases: .. code-block:: python - from ubi_config import get_loader + from ubiconfig import get_loader loader = get_loader() configs = loader.load_all() # returns a list of UbiConfig objects @@ -67,7 +67,7 @@ Except the above usage, there are some other use cases: .. code-block:: python - from ubi_config import get_loader + from ubiconfig import get_loader local_loader = get_loader(local=True) config = local_loader.load("full/path/to/local_ubi7_config") @@ -77,7 +77,7 @@ path by passing ``local_repo`` to ``get_loader`` .. code-block:: python - from ubi_config import get_loader + from ubiconfig import get_loader local_loader = get_loader(use=True, local_repo='repo/path') config = local_loader.load('local_ubi7_config') @@ -91,7 +91,7 @@ You can always reuse the loader API Reference ------------- -.. currentmodule:: ubi_config +.. currentmodule:: ubiconfig .. function:: get_loader Get a Loader instance which is used to load configurations. diff --git a/setup.py b/setup.py index 1742c9a..432496d 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ def get_description(): - return 'a simple tool used to load UBI config' + return 'A Python Library for accessing Universal Base Image configurations' def get_long_description(): @@ -24,11 +24,11 @@ def get_requirements(): version='0.1.0', author='', author_email='', - packages=['ubi_config', - 'ubi_config.utils', - 'ubi_config.utils.api', - 'ubi_config.config_types'], - package_data={'ubi_config': ['utils/config_schema.json']}, + packages=['ubiconfig', + 'ubiconfig.utils', + 'ubiconfig.utils.api', + 'ubiconfig.config_types'], + package_data={'ubiconfig': ['utils/config_schema.json']}, url='https://github.com/release-engineering/ubi-config', license='GNU General Public License', description=get_description(), diff --git a/tests/ubi_config/config_types/test_config_types.py b/tests/ubiconfig/config_types/test_config_types.py similarity index 97% rename from tests/ubi_config/config_types/test_config_types.py rename to tests/ubiconfig/config_types/test_config_types.py index 4cf78d0..bf8c99b 100644 --- a/tests/ubi_config/config_types/test_config_types.py +++ b/tests/ubiconfig/config_types/test_config_types.py @@ -1,4 +1,4 @@ -from ubi_config.config_types import packages, modules, content_sets +from ubiconfig.config_types import packages, modules, content_sets def test_package_with_arch(): diff --git a/tests/ubi_config/test_ubi.py b/tests/ubiconfig/test_ubi.py similarity index 96% rename from tests/ubi_config/test_ubi.py rename to tests/ubiconfig/test_ubi.py index 4ce7f80..0292820 100644 --- a/tests/ubi_config/test_ubi.py +++ b/tests/ubiconfig/test_ubi.py @@ -4,8 +4,8 @@ from mock import patch import yaml -from ubi_config import ubi -from ubi_config.utils.api.gitlab import RepoApi +from ubiconfig import ubi +from ubiconfig.utils.api.gitlab import RepoApi TEST_DATA_DIR = os.path.join(os.path.dirname(__file__), '../data') @@ -47,7 +47,7 @@ def make_response(content): @patch('requests.Session') -@patch('ubi_config.ubi.Loader._pre_load') +@patch('ubiconfig.ubi.Loader._pre_load') def test_load_all_from_default_repo(mocked_pre_load, mocked_session, files_branch_map, dnf7_config_file, ubi7_config_file, response): mocked_pre_load.return_value = files_branch_map @@ -134,14 +134,14 @@ def test_get_branches(mocked_session): {'name': 'ubi7', 'default': False, 'can_push': True}] mocked_session.get.return_value.json.return_value = branches repo_apis = RepoApi(ubi.DEFAULT_UBI_REPO) - with patch('ubi_config.ubi.Loader._pre_load'): + with patch('ubiconfig.ubi.Loader._pre_load'): loader = ubi.Loader(session=mocked_session, repo_api=repo_apis) actual_branches = loader._get_branches() assert actual_branches == ['dnf7', 'ubi7'] @patch('requests.Session') -@patch('ubi_config.ubi.Loader._get_branches') +@patch('ubiconfig.ubi.Loader._get_branches') def test_pre_load(mocked_get_branches, mocked_session, files_branch_map): branches = ['dnf7', 'ubi7'] mocked_get_branches.return_value = branches diff --git a/tests/ubi_config/utils/test_gitlab_api.py b/tests/ubiconfig/utils/test_gitlab_api.py similarity index 97% rename from tests/ubi_config/utils/test_gitlab_api.py rename to tests/ubiconfig/utils/test_gitlab_api.py index 55be697..5f9cf68 100644 --- a/tests/ubi_config/utils/test_gitlab_api.py +++ b/tests/ubiconfig/utils/test_gitlab_api.py @@ -1,7 +1,7 @@ import pytest from six.moves.urllib.parse import urljoin -from ubi_config.utils.api import gitlab +from ubiconfig.utils.api import gitlab @pytest.fixture diff --git a/tests/ubi_config/utils/test_validation.py b/tests/ubiconfig/utils/test_validation.py similarity index 86% rename from tests/ubi_config/utils/test_validation.py rename to tests/ubiconfig/utils/test_validation.py index bc43555..90f19a5 100644 --- a/tests/ubi_config/utils/test_validation.py +++ b/tests/ubiconfig/utils/test_validation.py @@ -2,7 +2,7 @@ import yaml -from ubi_config.utils import config_validation +from ubiconfig.utils import config_validation TEST_DATA = os.path.join(os.path.dirname(__file__), '../../data/configs/dnf7/rhel-atomic-host.yaml') diff --git a/tox.ini b/tox.ini index 0721d64..ea03f5d 100644 --- a/tox.ini +++ b/tox.ini @@ -16,7 +16,7 @@ deps= commands= flake8 \ --max-complexity 10 - sh -c 'pylint ubi_config; test $(( $? & (1|2|4|32) )) = 0' + sh -c 'pylint ubiconfig; test $(( $? & (1|2|4|32) )) = 0' [testenv:cov] deps= @@ -24,7 +24,7 @@ deps= pytest-cov usedevelop=true commands= - pytest --cov-report=html --cov=ubi_config {posargs} + pytest --cov-report=html --cov=ubiconfig {posargs} [testenv:cov-travis] passenv = TRAVIS TRAVIS_* @@ -34,7 +34,7 @@ deps= coveralls usedevelop=true commands= - pytest --cov=ubi_config {posargs} + pytest --cov=ubiconfig {posargs} coveralls [testenv:docs] diff --git a/ubi_config/__init__.py b/ubi_config/__init__.py deleted file mode 100644 index 3ec713b..0000000 --- a/ubi_config/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -from ubi_config.ubi import get_loader, Loader, UbiConfig - -__all__ = ['get_loader', 'Loader', 'UbiConfig'] diff --git a/ubiconfig/__init__.py b/ubiconfig/__init__.py new file mode 100644 index 0000000..f9c6fb6 --- /dev/null +++ b/ubiconfig/__init__.py @@ -0,0 +1,3 @@ +from ubiconfig.ubi import get_loader, Loader, UbiConfig + +__all__ = ['get_loader', 'Loader', 'UbiConfig'] diff --git a/ubi_config/config_types/__init__.py b/ubiconfig/config_types/__init__.py similarity index 100% rename from ubi_config/config_types/__init__.py rename to ubiconfig/config_types/__init__.py diff --git a/ubi_config/config_types/content_sets.py b/ubiconfig/config_types/content_sets.py similarity index 100% rename from ubi_config/config_types/content_sets.py rename to ubiconfig/config_types/content_sets.py diff --git a/ubi_config/config_types/modules.py b/ubiconfig/config_types/modules.py similarity index 100% rename from ubi_config/config_types/modules.py rename to ubiconfig/config_types/modules.py diff --git a/ubi_config/config_types/packages.py b/ubiconfig/config_types/packages.py similarity index 100% rename from ubi_config/config_types/packages.py rename to ubiconfig/config_types/packages.py diff --git a/ubi_config/ubi.py b/ubiconfig/ubi.py similarity index 99% rename from ubi_config/ubi.py rename to ubiconfig/ubi.py index fc55fe6..df46acf 100644 --- a/ubi_config/ubi.py +++ b/ubiconfig/ubi.py @@ -12,7 +12,7 @@ DEFAULT_UBI_REPO = os.getenv("DEFAULT_UBI_REPO", "") logging.basicConfig() -LOG = logging.getLogger('ubi_config') +LOG = logging.getLogger('ubiconfig') def get_loader(local=False, local_repo=None): diff --git a/ubi_config/utils/__init__.py b/ubiconfig/utils/__init__.py similarity index 100% rename from ubi_config/utils/__init__.py rename to ubiconfig/utils/__init__.py diff --git a/ubi_config/utils/api/__init__.py b/ubiconfig/utils/api/__init__.py similarity index 100% rename from ubi_config/utils/api/__init__.py rename to ubiconfig/utils/api/__init__.py diff --git a/ubi_config/utils/api/gitlab.py b/ubiconfig/utils/api/gitlab.py similarity index 100% rename from ubi_config/utils/api/gitlab.py rename to ubiconfig/utils/api/gitlab.py diff --git a/ubi_config/utils/config_schema.json b/ubiconfig/utils/config_schema.json similarity index 100% rename from ubi_config/utils/config_schema.json rename to ubiconfig/utils/config_schema.json diff --git a/ubi_config/utils/config_validation.py b/ubiconfig/utils/config_validation.py similarity index 100% rename from ubi_config/utils/config_validation.py rename to ubiconfig/utils/config_validation.py