From 331ed1911cfe944cd48bb1d3ba33b9f1c245d89e Mon Sep 17 00:00:00 2001
From: samueltwum1 <samueltwum1@gmail.com>
Date: Tue, 9 Feb 2021 15:45:42 +0200
Subject: [PATCH] SAR-189 Restructure package to use single namespace
---
CHANGELOG.rst | 7 +++++++
Makefile | 4 ++--
README.md | 12 ++++++------
docs/src/package/guide.rst | 2 +-
setup.py | 2 +-
src/{ska/logging => ska_logging}/__init__.py | 0
src/{ska/logging => ska_logging}/configuration.py | 0
tests/test_configuration.py | 10 +++++-----
8 files changed, 22 insertions(+), 15 deletions(-)
rename src/{ska/logging => ska_logging}/__init__.py (100%)
rename src/{ska/logging => ska_logging}/configuration.py (100%)
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index fdd2aa4..587cf7b 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -5,6 +5,13 @@ Change Log
All notable changes to this project will be documented in this file.
This project adheres to `Semantic Versioning <http://semver.org/>`_.
+v0.4.0
+******
+
+Change packaging to use single namespace.
+Usage like `from ska.logging import configure_logging` changes
+to `from ska_logging import configure_logging`.
+
v0.3.0
******
diff --git a/Makefile b/Makefile
index 59dd6f5..9b9fafe 100644
--- a/Makefile
+++ b/Makefile
@@ -25,8 +25,8 @@ lint:
# it is running in an importable folder with the same name.
python3 -m pip install pylint_junit pylint2junit; \
cd src; \
- pylint --output-format=parseable ska.logging.configuration | tee ../build/code_analysis.stdout; \
- pylint --output-format=pylint2junit.JunitReporter ska.logging.configuration > ../build/reports/linting.xml;
+ pylint --output-format=parseable ska_logging.configuration | tee ../build/code_analysis.stdout; \
+ pylint --output-format=pylint2junit.JunitReporter ska_logging.configuration > ../build/reports/linting.xml;
.PHONY: all test lint
diff --git a/README.md b/README.md
index 5fcc704..a7ecd16 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ For Python applications, this is as simple as:
```python
import logging
-from ska.logging import configure_logging
+from ska_logging import configure_logging
def main():
configure_logging()
@@ -29,7 +29,7 @@ be specified. It may be useful to link that to a command line option or environ
```python
import logging
-from ska.logging import configure_logging
+from ska_logging import configure_logging
def main():
configure_logging(logging.DEBUG)
@@ -45,7 +45,7 @@ No validation is done by this library. If the filter is `None` (the default), t
```python
import logging
-from ska.logging import configure_logging
+from ska_logging import configure_logging
class TangoDeviceTagsFilter(logging.Filter):
@@ -67,7 +67,7 @@ by the default configuration.
```python
import logging.handlers
-from ska.logging import configure_logging
+from ska_logging import configure_logging
ADDITIONAL_LOGGING_CONFIG = {
@@ -96,7 +96,7 @@ A more practical use case is adding and removing handlers at runtime.
```python
import logging
import logging.handlers
-from ska.logging import configure_logging, get_default_formatter
+from ska_logging import configure_logging, get_default_formatter
def main():
@@ -166,7 +166,7 @@ Code analysis
* Use [Pylint](https://www.pylint.org) as the code analysis framework
* By default it uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/)
* Use the provided `code-analysis.sh` script in order to run the code analysis in the `module` and `tests`
- * Code analysis should be run by calling `pylint ska.logging`. All pertaining options reside under the `.pylintrc` file.
+ * Code analysis should be run by calling `pylint ska_logging`. All pertaining options reside under the `.pylintrc` file.
* Code analysis should only raise document related warnings (i.e. `#FIXME` comments) before merging the code
Writing documentation
diff --git a/docs/src/package/guide.rst b/docs/src/package/guide.rst
index 3f55393..20e07ce 100644
--- a/docs/src/package/guide.rst
+++ b/docs/src/package/guide.rst
@@ -22,5 +22,5 @@ Public API Documentation
Functions
---------
-.. automodule:: ska.logging
+.. automodule:: ska_logging
:members:
diff --git a/setup.py b/setup.py
index 6821fbb..cc7388d 100644
--- a/setup.py
+++ b/setup.py
@@ -14,7 +14,7 @@ setup(
author="Anton Joubert",
author_email="ajoubert+ska@ska.ac.za",
url="https://gitlab.com/ska-telescope/ska-logging",
- packages=setuptools.find_namespace_packages(where="src", include=["ska.*"]),
+ packages=setuptools.find_namespace_packages(where="src"),
package_dir={"": "src"},
include_package_data=True,
license="BSD license",
diff --git a/src/ska/logging/__init__.py b/src/ska_logging/__init__.py
similarity index 100%
rename from src/ska/logging/__init__.py
rename to src/ska_logging/__init__.py
diff --git a/src/ska/logging/configuration.py b/src/ska_logging/configuration.py
similarity index 100%
rename from src/ska/logging/configuration.py
rename to src/ska_logging/configuration.py
diff --git a/tests/test_configuration.py b/tests/test_configuration.py
index d10ff72..e168819 100644
--- a/tests/test_configuration.py
+++ b/tests/test_configuration.py
@@ -7,9 +7,9 @@ import logging.handlers
import time
import pytest
-import ska.logging.configuration as configuration
+import ska_logging.configuration as configuration
-from ska.logging import configure_logging, get_default_formatter
+from ska_logging import configure_logging, get_default_formatter
@pytest.fixture
@@ -104,7 +104,7 @@ def recording_tags_logger():
@pytest.mark.usefixtures("reset_logging")
class TestConfigureLogging:
- """Tests for :func:`~ska.logging.configuration.configure_logging`."""
+ """Tests for :func:`~ska_logging.configuration.configure_logging`."""
def test_includes_console_handler(self, default_logger):
assert get_named_handler(default_logger, "console")
@@ -170,7 +170,7 @@ class TestConfigureLogging:
@pytest.mark.usefixtures("reset_logging")
class TestGetDefaultFormatter:
- """Tests for :func:`~ska.logging.configuration.get_default_formatter`."""
+ """Tests for :func:`~ska_logging.configuration.get_default_formatter`."""
def get_recorded_message(self, logger):
logger.info("test message")
@@ -199,7 +199,7 @@ class TestGetDefaultFormatter:
class TestOverride:
- """Tests for :func:`~ska.logging.configuration._override`.
+ """Tests for :func:`~ska_logging.configuration._override`.
Code based on:
https://github.com/ska-sa/katsdpcontroller/blob/
--
GitLab