Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .coverage
Binary file not shown.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,6 @@ update:
docker:
docker build --no-cache -f Dockerfile -t change_me-smoke .
docker run --rm change_me-smoke

app:
poetry run python -m change_me
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To install the library run: `pip install change-me`
5. `poetry publish --build` to build and publish to https://pypi.org/project/change-me


## Usage
## Module Usage
```
"""Basic docstring for my module."""

Expand All @@ -26,3 +26,8 @@ logger.info("Hello World!")
if __name__ == "__main__":
main()
```

## Program Usage
```bash
poetry run python -m change_me
```
12 changes: 6 additions & 6 deletions src/change_me/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@
from change_me.utils import setup_logger


def main(log_level: str) -> None:
def main(log_level: str = DEFAULT_LOG_LEVEL) -> None:
"""Run the pipeline."""
setup_logger(filename="log_file", log_dir=None, log_level=log_level)
logger.info("Hello world!")
logger.info("Hello, world!")


if __name__ == "__main__":
parser = argparse.ArgumentParser()
if __name__ == "__main__": # pragma: no cover
parser = argparse.ArgumentParser("Run the pipeline.")
parser.add_argument(
"--log-level",
default=DEFAULT_LOG_LEVEL,
choices=list(LogLevel),
help="Log level.",
choices=list(LogLevel()),
help="Set the log level.",
)
args = parser.parse_args()

Expand Down
10 changes: 10 additions & 0 deletions tests/main_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
"""Test the main program."""

from change_me.__main__ import main


def test_main():
"""Test the main function."""
result = main()

assert result is None
12 changes: 11 additions & 1 deletion tests/utils_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,23 @@
from pathlib import Path
from tempfile import TemporaryDirectory

from change_me.definitions import LogLevel
from change_me.utils import setup_logger


def test_logger_init():
def test_logger_init() -> None:
"""Test logger initialization."""
with TemporaryDirectory() as log_dir:
log_dir_path = Path(log_dir)
log_filepath = setup_logger(filename="log_file", log_dir=log_dir_path)
assert Path(log_filepath).exists()
assert not Path(log_filepath).exists()


def test_log_level() -> None:
"""Test the log level."""
# Act
log_levels = list(LogLevel())

# Assert
assert type(log_levels) is list
Loading