Chore/auto formatting workflow

.github/workflows/auto-format.yml

@@ -0,0 +1,49 @@
+name: AutoUpdateFormatting
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  code-formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'  # Specify the desired Python version
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements_test.txt
+
+      - name: Updating README files
+        id: update_readme
+        run: |
+          bash scripts/update-readme.sh
+          bash scripts/auto-commit.sh "Updating README files"
+        continue-on-error: true
+
+      - name: Code formatting and committing changes
+        id: code_format
+        run: |
+          bash scripts/auto-format.sh
+          bash scripts/auto-commit.sh "Automated formatting changes"
+        continue-on-error: true
+
+      - name: Push changes
+        if: ${{ steps.update_readme.outcome == 'success' || steps.code_format.outcome == 'success' }}
+        uses: ad-m/github-push-action@master
+        with:
+          branch: ${{ github.head_ref }}

README.md

@@ -268,4 +268,3 @@ Furthermore, it is also shown how the entire *Efficient Frontier* and the optima
 Also, the optimisation of a portfolio and its visualisation based on a *Monte Carlo* is shown.
 
 Finally, *FinQuant*'s visualisation methods allow for overlays, if this is desired. Thus, with only the following few lines of code, one can create an overlay of the *Monte Carlo* run, the *Efficient Frontier*, its optimised portfolios for *Minimum Volatility* and *Maximum Sharpe Ratio*, as well as the portfolio's individual stocks.
-

example/Example-Analysis.py

@@ -9,10 +9,11 @@
 
 # <codecell>
 
+import datetime
 import pathlib
+
 import matplotlib.pyplot as plt
 import pandas as pd
-import datetime
 
 # importing FinQuant's function to automatically build the portfolio
 from finquant.portfolio import build_portfolio

example/Example-Build-Portfolio-from-file.py

@@ -9,9 +9,10 @@
 
 # <codecell>
 
+import datetime
 import pathlib
+
 import pandas as pd
-import datetime
 
 # importing FinQuant's function to automatically build the portfolio
 from finquant.portfolio import build_portfolio

example/Example-Build-Portfolio-from-web.py

@@ -9,9 +9,10 @@
 
 # <codecell>
 
-import pandas as pd
 import datetime
 
+import pandas as pd
+
 # importing some custom functions/objects
 from finquant.portfolio import build_portfolio
 

example/Example-Optimisation.py

@@ -26,11 +26,12 @@
 
 # <codecell>
 
+import datetime
 import pathlib
+
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
-import datetime
 
 # importing FinQuant's function to automatically build the portfolio
 from finquant.portfolio import build_portfolio

finquant/asset.py

@@ -45,7 +45,9 @@ class Asset:
 
     """
 
-    def __init__(self, data: pd.Series, name: str, asset_type: str = 'Market index') -> None:
+    def __init__(
+        self, data: pd.Series, name: str, asset_type: str = "Market index"
+    ) -> None:
         """
         :Input:
          :data: ``pandas.Series``, of asset prices
@@ -119,4 +121,4 @@ def properties(self):
     def __str__(self):
         # print short description
         string = f"Contains information about {self.asset_type}: {self.name}."
-        return string
+        return string

finquant/market.py

@@ -14,6 +14,7 @@
 
 import numpy as np
 import pandas as pd
+
 from finquant.asset import Asset
 from finquant.returns import daily_returns, historical_mean_return
 
@@ -43,4 +44,4 @@ def comp_daily_returns(self) -> pd.Series:
         """Computes the daily returns (percentage change) of the market index.
         See ``finquant.returns.daily_returns``.
         """
-        return daily_returns(self.data)
+        return daily_returns(self.data)

finquant/portfolio.py

@@ -49,8 +49,8 @@
 - Individual stocks of the portfolio (Expected Return over Volatility)
 """
 
-from typing import List
 import datetime
+from typing import List
 
 import matplotlib.pylab as plt
 import numpy as np

finquant/stock.py

@@ -25,6 +25,7 @@
 
 import numpy as np
 import pandas as pd
+
 from finquant.asset import Asset
 from finquant.returns import daily_returns, historical_mean_return
 

requirements_dev.txt

@@ -1,4 +1,4 @@
-black==23.1.0
+black
 mypy
 isort
 jupyter

requirements_test.txt

@@ -1,2 +1,5 @@
 pytest>=7.3.2
+black
+mypy
+isort
 pylint

scripts/auto-commit.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+echo "Running auto commit"
+
+COMMITMSG=$1
+
+if [ -z "$COMMITMSG" ]; then
+	COMMITMSG="Automated formatting changes"
+fi
+
+# Stage changes
+git add --update
+
+# Check Git diff-index
+git diff-index --quiet HEAD --
+
+if [ $? -eq 0 ]; then
+	echo "No changes found, nothing to see/do here."
+	exit 1
+else
+	echo "Changes found. Preparing commit."
+	git config --local user.email "github-actions[bot]@users.noreply.github.com"
+	git config --local user.name "github-actions[bot]"
+	git commit -m "${COMMITMSG}"
+fi

scripts/auto-format.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# Code formatting with isort and black
+echo "Code formatting with isort and black:"
+isort $(git ls-files '*.py')
+black $(git ls-files '*.py')

scripts/update-readme.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+update_version_readme() {
+	local version_file="version"
+	local readme_md="$1"
+
+	# Read the current version from the "version" file
+	local current_version=$(grep -Eo 'version=([0-9]+\.){2}[0-9]+' "$version_file" | cut -d'=' -f2)
+
+	update_file() {
+		local file=$1
+		sed -i "s/pypi-v[0-9]\+\.[0-9]\+\.[0-9]\+/pypi-v$current_version/" "$file"
+		echo "Version updated to $current_version in $file"
+	}
+
+	# Update version in README.md
+	update_file "$readme_md"
+}
+
+update_readme_tex() {
+	local file_path="$1"
+
+	# Copy README.md to README.tex.md
+	cp README.md "$file_path"
+
+	# Read the contents of README.tex.md
+	local content=$(<"$file_path")
+
+	# Replace patterns
+	content=$(echo "$content" | sed -E "s/<img src=\"(.*?)\" align=middle width=194.52263655pt height=46.976899200000005pt\/>/\$\\\\displaystyle\\\\dfrac{\\\\text{price}_{t_i} - \\\\text{price}_{t_0} + \\\\text{dividend}}{\\\\text{price}_{t_0}}\$/")
+
+	content=$(echo "$content" | sed -E "s/<img src=\"(.*?)\" align=middle width=126.07712039999997pt height=48.84266309999997pt\/>/\$\\\\displaystyle\\\\dfrac{\\\\text{price}_{t_i} - \\\\text{price}_{t_{i-1}}}{\\\\text{price}_{t_{i-1}}}\$/")
+
+	content=$(echo "$content" | sed -E "s/<img src=\"(.*?)\" align=middle width=208.3327686pt height=57.53473439999999pt\/>/\$\\\\displaystyle\\\\log\\\\left(1 + \\\\dfrac{\\\\text{price}_{t_i} - \\\\text{price}_{t_{i-1}}}{\\\\text{price}_{t_{i-1}}}\\\\right)\$/")
+
+	# Write the updated contents back to README.tex.md
+	echo "$content" > "$file_path"
+}
+
+# Update both readme files:
+echo "Updating README files:"
+update_version_readme "README.md"
+update_readme_tex "README.tex.md"

setup.py

@@ -21,10 +21,10 @@ def read_requirements(file_path):
 install_requires = read_requirements("requirements.txt")
 
 extras_require = {
-    "test": read_requirements("requirements_test.txt"),
+    "cd": read_requirements("requirements_cd.txt"),
     "dev": read_requirements("requirements_dev.txt"),
     "docs": read_requirements("requirements_docs.txt"),
-    "cd": read_requirements("requirements_cd.txt"),
+    "test": read_requirements("requirements_test.txt"),
 }
 
 setuptools.setup(