Merge pull request #1 from dannyp11/dev

Add symbol & doc

Author: dannyp11

.github/workflows/test.yml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python: [3.6, 3.7, 3.8, 3.9]

README.md

@@ -1,10 +1,31 @@
 # Introduction
-This is unofficial https://exchangerate.host python client library
+This is unofficial https://exchangerate.host (https://github.com/Formicka/exchangerate.host) python client library
 
 # Getting started
 
 ## Installation
+- Using pip `pip install exchangerate-client
 
-## Sample usage
+## Usage
+- Get all currency symbols
+```
+import exchangerate
+client = exchangerate.ExchangerateClient()
+print(client.symbols())
+```
 
-# Development guide
+## Configuration
+- 
+
+# Development guide
+## Testing
+This package uses `tox` to run testing automation against multiple python versions, to install and run tox, use
+
+```
+pip install tox
+tox
+```
+
+## Local development
+- Install to local env with `pip install --editable .`
+- Then this will work `python -c "import exchangerate"`

setup.cfg

@@ -1,3 +1,3 @@
 [metadata]
-version = attr: examplepy.__version__
+version = attr: exchangerate.__version__
 license_files = LICENSE

setup.py

@@ -4,7 +4,7 @@
     long_description = fh.read()
 
 setuptools.setup(
-    name='exchangerate-python',
+    name='exchangerate-client',
     author='Daniel Pham',
     author_email='[email protected]',
     description='Unofficial exchangerate.host python client library',
@@ -39,7 +39,7 @@
         'Operating System :: OS Independent',
     ],
     python_requires='>=3.6',
-    # install_requires=['Pillow'],
+    install_requires=['requests'],
     extras_require={
         'dev': ['check-manifest'],
         # 'test': ['coverage'],

src/examplepy/__init__.py

@@ -0,0 +1,4 @@
+__version__ = "0.1.0"
+
+from .config import Region
+from .client import ExchangerateClient

src/examplepy/module1.py

@@ -0,0 +1,56 @@
+import requests
+from collections import namedtuple
+from urllib.parse import urlencode, urlunparse
+
+from .config import Region
+from .exceptions import *
+
+class ExchangerateClient:
+    """
+    Primary client class
+    """
+    def __init__(self, base_currency="USD", region=Region.AMERICA):
+        self.base_currency = base_currency
+        self.region = region
+        self.session = requests.Session()
+
+    # -------------------------------------------------------------------
+    # Public methods
+    # -------------------------------------------------------------------
+
+    def symbols(self):
+        url = self._build_url(path="symbols")
+        resp_json = self._validate_and_get_json(url)
+        return resp_json.get("rates")
+
+    # -------------------------------------------------------------------
+    def _validate_and_get_json(self, url):
+            resp = self.session.get(url)
+            if resp.status_code != 200:
+                raise ResponseErrorException("Status code=%d calling url=%s" % (resp.status_code, url))
+
+            resp_json = resp.json()
+            if not resp_json.get("success", False):
+                raise ResponseErrorException("No success field calling url=%s" % (url))
+
+            return resp_json
+
+    def _build_url(self, path="", params=None):
+        Components = namedtuple(
+            typename='Components',
+            field_names=['scheme', 'netloc', 'url', 'path', 'query', 'fragment']
+        )
+
+        if not params:
+            params = {}
+
+        return urlunparse(
+            Components(
+                scheme='https',
+                netloc=self.region.value,
+                query=urlencode(params),
+                path=path,
+                url="/",
+                fragment=""
+            )
+        )

src/exchangerate/__init__.py

@@ -0,0 +1,5 @@
+from enum import Enum
+
+class Region(Enum):
+    EUROPE = "api.exchangerate.host"
+    AMERICA = "api-us.exchangerate.host"

src/exchangerate/client.py

@@ -0,0 +1,5 @@
+class ExchangerateException(Exception):
+    pass
+
+class ResponseErrorException(ExchangerateException):
+    pass

src/exchangerate/config.py

@@ -0,0 +1,9 @@
+from exchangerate.client import ExchangerateClient
+
+def test_get_symbols():
+    client = ExchangerateClient()
+    all_symbols = client.symbols()
+
+    assert "USD" in all_symbols
+    assert "CAD" in all_symbols
+    assert "AUD" in all_symbols