Skip to content
Snippets Groups Projects
Unverified Commit d7873797 authored by samueltwum1's avatar samueltwum1
Browse files

SAR-189 Include 'ser' in package name

This after request from the Architecture Team, to better match the module view.
https://confluence.skatelescope.org/display/SWSI/Views%3A+Module
parent 686825d2
Branches
Tags
No related merge requests found
3.7.7
...@@ -10,13 +10,13 @@ v0.4.0 ...@@ -10,13 +10,13 @@ v0.4.0
Change packaging to use single namespace. Change packaging to use single namespace.
Usage like `from ska.logging import configure_logging` changes Usage like `from ska.logging import configure_logging` changes
to `from ska_logging import configure_logging`. to `from ska_ser_logging import configure_logging`.
v0.3.0 v0.3.0
****** ******
Change packaging to use "ska" namespace. Change packaging to use "ska" namespace.
Usage like `from ska_logging import configure_logging` changes Usage like `from ska_ser_logging import configure_logging` changes
to `from ska.logging import configure_logging`. to `from ska.logging import configure_logging`.
v0.2.1 v0.2.1
......
...@@ -22,8 +22,8 @@ lint: ...@@ -22,8 +22,8 @@ lint:
# FIXME pylint needs to run twice since there is no way go gather the text and junit xml output at the same time # FIXME pylint needs to run twice since there is no way go gather the text and junit xml output at the same time
python3 -m pip install pylint_junit pylint2junit; \ python3 -m pip install pylint_junit pylint2junit; \
cd src; \ cd src; \
pylint --output-format=parseable ska_logging | tee ../build/code_analysis.stdout; \ pylint --output-format=parseable ska_ser_logging | tee ../build/code_analysis.stdout; \
pylint --output-format=pylint2junit.JunitReporter ska_logging > ../build/reports/linting.xml; pylint --output-format=pylint2junit.JunitReporter ska_ser_logging > ../build/reports/linting.xml;
.PHONY: all test lint .PHONY: all test lint
SKA Logging Configuration Library SKA Logging Configuration Library
================================= =================================
[![Documentation Status](https://readthedocs.org/projects/ska-logging/badge/?version=latest)](https://developer.skatelescope.org/projects/ska-logging/en/latest/?badge=latest) [![Documentation Status](https://readthedocs.org/projects/ska-ser-logging/badge/?version=latest)](https://developer.skatelescope.org/projects/ska-ser-logging/en/latest/?badge=latest)
This project allows standard logging configuration across all SKA projects. The format used is described in detail This project allows standard logging configuration across all SKA projects. The format used is described in detail
on the [developer portal](https://developer.skatelescope.org/en/latest/development/logging-format.html). on the [developer portal](https://developer.skatelescope.org/en/latest/development/logging-format.html).
...@@ -17,7 +17,7 @@ For Python applications, this is as simple as: ...@@ -17,7 +17,7 @@ For Python applications, this is as simple as:
```python ```python
import logging import logging
from ska_logging import configure_logging from ska_ser_logging import configure_logging
def main(): def main():
configure_logging() configure_logging()
...@@ -29,7 +29,7 @@ be specified. It may be useful to link that to a command line option or environ ...@@ -29,7 +29,7 @@ be specified. It may be useful to link that to a command line option or environ
```python ```python
import logging import logging
from ska_logging import configure_logging from ska_ser_logging import configure_logging
def main(): def main():
configure_logging(logging.DEBUG) configure_logging(logging.DEBUG)
...@@ -45,7 +45,7 @@ No validation is done by this library. If the filter is `None` (the default), t ...@@ -45,7 +45,7 @@ No validation is done by this library. If the filter is `None` (the default), t
```python ```python
import logging import logging
from ska_logging import configure_logging from ska_ser_logging import configure_logging
class TangoDeviceTagsFilter(logging.Filter): class TangoDeviceTagsFilter(logging.Filter):
...@@ -67,7 +67,7 @@ by the default configuration. ...@@ -67,7 +67,7 @@ by the default configuration.
```python ```python
import logging.handlers import logging.handlers
from ska_logging import configure_logging from ska_ser_logging import configure_logging
ADDITIONAL_LOGGING_CONFIG = { ADDITIONAL_LOGGING_CONFIG = {
...@@ -96,7 +96,7 @@ A more practical use case is adding and removing handlers at runtime. ...@@ -96,7 +96,7 @@ A more practical use case is adding and removing handlers at runtime.
```python ```python
import logging import logging
import logging.handlers import logging.handlers
from ska_logging import configure_logging, get_default_formatter from ska_ser_logging import configure_logging, get_default_formatter
def main(): def main():
......
...@@ -22,5 +22,5 @@ Public API Documentation ...@@ -22,5 +22,5 @@ Public API Documentation
Functions Functions
--------- ---------
.. automodule:: ska_logging .. automodule:: ska_ser_logging
:members: :members:
...@@ -8,13 +8,13 @@ with open("README.md") as readme_file: ...@@ -8,13 +8,13 @@ with open("README.md") as readme_file:
readme = readme_file.read() readme = readme_file.read()
setup( setup(
name="ska_logging", name="ska_ser_logging",
description="Square Kilometre Array logging configuration library", description="Square Kilometre Array logging configuration library",
long_description=readme + "\n\n", long_description=readme + "\n\n",
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
author="Anton Joubert", author="Anton Joubert",
author_email="ajoubert+ska@ska.ac.za", author_email="ajoubert+ska@ska.ac.za",
url="https://gitlab.com/ska-telescope/ska-logging", url="https://gitlab.com/ska-telescope/ska-ser-logging",
packages=find_packages("src"), packages=find_packages("src"),
package_dir={"": "src"}, package_dir={"": "src"},
include_package_data=True, include_package_data=True,
......
File moved
...@@ -7,9 +7,9 @@ import logging.handlers ...@@ -7,9 +7,9 @@ import logging.handlers
import time import time
import pytest import pytest
import ska_logging.configuration as configuration import ska_ser_logging.configuration as configuration
from ska_logging import configure_logging, get_default_formatter from ska_ser_logging import configure_logging, get_default_formatter
@pytest.fixture @pytest.fixture
...@@ -104,7 +104,7 @@ def recording_tags_logger(): ...@@ -104,7 +104,7 @@ def recording_tags_logger():
@pytest.mark.usefixtures("reset_logging") @pytest.mark.usefixtures("reset_logging")
class TestConfigureLogging: class TestConfigureLogging:
"""Tests for :func:`~ska_logging.configuration.configure_logging`.""" """Tests for :func:`~ska_ser_logging.configuration.configure_logging`."""
def test_includes_console_handler(self, default_logger): def test_includes_console_handler(self, default_logger):
assert get_named_handler(default_logger, "console") assert get_named_handler(default_logger, "console")
...@@ -170,7 +170,7 @@ class TestConfigureLogging: ...@@ -170,7 +170,7 @@ class TestConfigureLogging:
@pytest.mark.usefixtures("reset_logging") @pytest.mark.usefixtures("reset_logging")
class TestGetDefaultFormatter: class TestGetDefaultFormatter:
"""Tests for :func:`~ska_logging.configuration.get_default_formatter`.""" """Tests for :func:`~ska_ser_logging.configuration.get_default_formatter`."""
def get_recorded_message(self, logger): def get_recorded_message(self, logger):
logger.info("test message") logger.info("test message")
...@@ -199,7 +199,7 @@ class TestGetDefaultFormatter: ...@@ -199,7 +199,7 @@ class TestGetDefaultFormatter:
class TestOverride: class TestOverride:
"""Tests for :func:`~ska_logging.configuration._override`. """Tests for :func:`~ska_ser_logging.configuration._override`.
Code based on: Code based on:
https://github.com/ska-sa/katsdpcontroller/blob/ https://github.com/ska-sa/katsdpcontroller/blob/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment