diff --git a/README.md b/README.md index 76e3fb4..902bc87 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,16 @@ Simple reusable python resources for digital publishing. ## Installation -**TODO** +Follow these steps to install the package on your local machine: + +1. **Install the package** + + Open your terminal and run the following command: + + ```bash + pip install git+https://github.com/GSS-Cogs/dp-python-tools.git + ``` + ## Usage diff --git a/dpytools/__init__.py b/dpytools/__init__.py index bff3af3..048de67 100644 --- a/dpytools/__init__.py +++ b/dpytools/__init__.py @@ -1,5 +1,5 @@ -from http.http import HttpClient -from config.config import Config +from http_clients.http import HttpClient +from config.config import Config from logger.logger import logger from slack.slack import SlackNotifier -from sns.sns import Subscription, publish \ No newline at end of file +from sns.sns import Subscription, publish diff --git a/dpytools/config/config.py b/dpytools/config/config.py index c8b8daf..efc38e3 100644 --- a/dpytools/config/config.py +++ b/dpytools/config/config.py @@ -1,7 +1,6 @@ from typing import Dict -from properties.base import BaseProperty - +from .properties.base import BaseProperty class Config: diff --git a/dpytools/config/properties/__init__.py b/dpytools/config/properties/__init__.py index c7e4bfb..d6eca2d 100644 --- a/dpytools/config/properties/__init__.py +++ b/dpytools/config/properties/__init__.py @@ -1 +1 @@ -from string import StringProperty \ No newline at end of file +from .string import StringProperty \ No newline at end of file diff --git a/dpytools/config/properties/base.py b/dpytools/config/properties/base.py index 7a1dd4d..02dd34c 100644 --- a/dpytools/config/properties/base.py +++ b/dpytools/config/properties/base.py @@ -3,7 +3,7 @@ from typing import Any, Union, Tuple, Optional @dataclass -class BaseProperty(meta=ABCMeta): +class BaseProperty(metaclass=ABCMeta): name: str value: Any diff --git a/dpytools/config/properties/string.py b/dpytools/config/properties/string.py index adf5bee..74aa102 100644 --- a/dpytools/config/properties/string.py +++ b/dpytools/config/properties/string.py @@ -1,6 +1,6 @@ from typing import Optional -from base import BaseProperty +from .base import BaseProperty class StringProperty(BaseProperty): diff --git a/dpytools/http/README.md b/dpytools/http_clients/README.md similarity index 100% rename from dpytools/http/README.md rename to dpytools/http_clients/README.md diff --git a/dpytools/http/http.py b/dpytools/http_clients/http.py similarity index 100% rename from dpytools/http/http.py rename to dpytools/http_clients/http.py diff --git a/tests/test_nothing.py b/tests/test_nothing.py new file mode 100644 index 0000000..e483b19 --- /dev/null +++ b/tests/test_nothing.py @@ -0,0 +1,7 @@ + +# TODO - remove as soon as we add our first test. +def test_nothing(): + """ + Empty test to stop failures for 0 coverage + """ + ... \ No newline at end of file