Merge pull request #2 from dc-aichara/feat/poetry

Feat/poetry

Author: dc-aichara

.github/workflows/python-package.yml

@@ -0,0 +1,53 @@
+name: Python package
+
+on:
+  push:
+    branches:
+    - main
+    - master
+    - release/*
+  pull_request:
+    branches:
+    - main
+    - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Poetry and dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry
+        poetry install
+    - name: Check Code Format
+      run: |
+        poetry run black .
+        poetry run isort .
+        poetry run pflake8 . --config pyproject.toml
+    - name: Static Type Checking
+      run: |
+        poetry run mypy --config-file=pyproject.toml .
+    - name: Test with pytest
+      run: |
+        poetry run pytest tests -s -vv --durations=0 \
+            --junitxml=test_report.xml \
+            --cov-report=term \
+            --cov-report xml PriceIndices \
+            --cov=PriceIndices
+        poetry run coverage xml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,5 +1,6 @@
 .DS_STORE
 __pycache__/
-dist/
 PriceIndices.egg-info/
 bist/
+dist/
+build/

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: 23.1.0
+    hooks:
+    -   id: black
+        args: [--config=pyproject.toml]
+-   repo:  https://github.com/csachs/pyproject-flake8
+    rev: v6.0.0.post1
+    hooks:
+    -   id: pyproject-flake8
+        entry: pflake8
+        args: [--config=pyproject.toml]
+-   repo: https://github.com/kynan/nbstripout
+    rev: 0.6.1
+    hooks:
+      - id: nbstripout
+        files: ".ipynb"
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.991
+    hooks:
+    -   id: mypy
+        args: [--config-file=pyproject.toml]
+        additional_dependencies: [types-requests]
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+    -   id: isort

ChangeLog.md

@@ -1,8 +1,22 @@
 # PriceIndices ChangeLog
 
+## Version 
+
+## 1.4.0
+
+* Refactored code
+* Adapted poetry for development
+* Updated documentation.
+
+## Version 1.3.0
+
+* Optimize Indicators calculations.
+* Minor bug fixes.
+* Refactored code.
+
 ## Version 1.2.1
 
-- Fixed documentation
+- Fixed documentation.
 
 ## Version 1.2.0
 

PriceIndices/__init__.py

@@ -1,4 +1,6 @@
+from importlib.metadata import version
+
+__version__ = version("PriceIndices")
+
 from .crypto_history import MarketHistory
 from .price_indicators import Indices
-
-__version__ = "1.3.0"

PriceIndices/crypto_history.py

@@ -1,19 +1,20 @@
-import requests
+import warnings
+from typing import Optional
+
 import pandas as pd
-from datetime import datetime
-from typing import Any, Optional
+import requests
 from requests.adapters import HTTPAdapter
 from requests.packages.urllib3.util.retry import Retry
-import warnings
 
 warnings.filterwarnings("ignore")
 
 
 class MarketHistory(object):
-    __Crypto_Market_Base_URL = "https://web-api.coinmarketcap.com/v1/cryptocurrency/ohlcv/historical?convert=USD&slug="
+    __Crypto_Market_Base_URL = "https://web-api.coinmarketcap.com/v1/cryptocurrency/ohlcv/historical?convert=USD&slug="  # noqa
 
-    def __init__(self,
-                 base_url: Optional[str] = __Crypto_Market_Base_URL) -> None:
+    def __init__(
+        self, base_url: Optional[str] = __Crypto_Market_Base_URL
+    ) -> None:
         self.base_url = base_url
         self.request_timeout = 120
 
@@ -23,7 +24,7 @@ def __init__(self,
         )
         self.session.mount("http://", HTTPAdapter(max_retries=retries))
 
-    def __request(self, url: str) -> pd.DataFrame:
+    def __request(self, url: str) -> Optional[pd.DataFrame]:
         try:
             response = self.session.get(url, timeout=self.request_timeout)
             response.raise_for_status()
@@ -39,10 +40,10 @@ def __request(self, url: str) -> pd.DataFrame:
             del df["timestamp"]
             return df
         except Exception as e:
-            raise
+            raise e
 
     def get_history(
-            self, coin_id: str, start_date: str, end_date: str
+        self, coin_id: str, start_date: str, end_date: str
     ) -> Optional[pd.DataFrame]:
         """
         Get historical market data of a cryptocurrency from CoinMarketCap.
@@ -63,12 +64,14 @@ def get_history(
         except Exception as e:
             print(e)
             print(
-                'Please, check inputs. Coin id, and dates are strings. Date '
+                "Please, check inputs. Coin id, and dates are strings. Date "
                 'format is "YYYY-MM-DD"'
             )
+            return None
 
-    def get_price(self, coin_id: str, start_date: str, end_date: str) -> \
-            Optional[pd.DataFrame]:
+    def get_price(
+        self, coin_id: str, start_date: str, end_date: str
+    ) -> Optional[pd.DataFrame]:
         """
         Get historical market price data (closing price) of a cryptocurrency
         from CoinMarketCap.
@@ -87,12 +90,14 @@ def get_price(self, coin_id: str, start_date: str, end_date: str) -> \
 
         try:
             df = self.__request(url)
+            assert type(df) == pd.DataFrame
             df = df[["date", "close"]]
             df.columns = ["date", "price"]
             return df
         except Exception as e:
             print(
                 e,
-                'Please, check inputs Coin id, and dates are strings. Date '
+                "Please, check inputs Coin id, and dates are strings. Date "
                 'format is "YYYY-MM-DD"',
             )
+            return None