Merge branch 'test'

.github/workflows/pylint.yaml

@@ -18,6 +18,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pylint
+        if [ -f requirements/requirements.txt ]; then pip install -r requirements/requirements.txt; fi
     - name: Analysing the code with pylint
       run: |
         pylint $(git ls-files '*.py')

.github/workflows/python-app.yaml

@@ -3,11 +3,7 @@
 
 name: Python application
 
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
+on: [push]
 
 permissions:
   contents: read
@@ -27,7 +23,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements/requirements.txt ]; then pip install -r requirements/requirements.txt; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

README.rst

@@ -7,6 +7,9 @@ MStarpy provides stock and fund public data to retail and professional investors
 
 The project is **open-source** and anyone can contribute on `github <https://github.com/Mael-J/mstarpy>`_.
 
+
+[![GitHub release](https://img.shields.io/github/v/release/Mael-J/mstarpy.svg?maxAge=3600)](https://github.com/Mael-J/mstarpy./releases)
+
 Getting Started
 ===============
 

docs/conf.py

@@ -1,4 +1,4 @@
-# Configuration file for the Sphinx documentation builder.
+""" Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
@@ -9,14 +9,14 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+"""
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
 # -- Project information -----------------------------------------------------
 
-project = 'mstarpy'
+project = 'MSTARPY'
 copyright = '2023, Maël Jourdain'
 author = 'Maël Jourdain'
 

mstarpy/__init__.py

@@ -1,5 +1,8 @@
+# flake8: noqa
+
+""" mstarpy init """
 from .funds import Funds
 from .stock import Stock
 from .search import filter_universe, search_field, search_filter, search_funds, search_stock
 
-__version__ = "1.0.4"
+__version__ = "1.0.4"

mstarpy/error.py

@@ -1,25 +1,25 @@
-def not_200_response(url,response):
-    """
-    This function raise a ConnectionError if the status code a requests is not 200.
+"""module to raise error"""
+
 
+def not_200_response(url, response):
+    """
+    This function raise a ConnectionError
+    if the status code a requests is not 200.
     """
     if not response.status_code == 200:
-        raise ConnectionError(f"Error {response.status_code} for the api {url}. Message : {response.reason}.")
+        raise ConnectionError(
+            f"""Error {response.status_code}
+            for the api {url}. Message : {response.reason}."""
+        )
 
 
 def no_site_error(code, name, country, site):
-    """ 
-    This function raise a ValueError if the selected country is "us" or a site is not selected.
-    
     """
-
-
-    if not site or country == 'us':
+    This function raise a ValueError if the
+    selected country is "us" or a site is not selected.
+    """
+    if not site or country == "us":
         if country:
-            raise ValueError(f"The funds of the country {country} cannot be scraped.")
-        else:
-            raise ValueError(f"The funds {name} ({code}) cannot be scraped.")
-
-
-
-
+            raise ValueError(f"""The funds of the
+                             country {country} cannot be scraped.""")
+        raise ValueError(f"The funds {name} ({code}) cannot be scraped.")