-
-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add formatting for percentages for the package
- Loading branch information
Showing
3 changed files
with
320 additions
and
307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,26 @@ | ||
| import setuptools | ||
|
|
||
| with open("README.md", "r") as fh: | ||
| long_description = fh.read() | ||
|
|
||
| setuptools.setup( | ||
| name="thepassiveinvestor", | ||
| packages=["thepassiveinvestor"], | ||
| version="1.0.9", | ||
| license="MIT", | ||
| description="Passive Investing for the Average Joe.", | ||
| author="JerBouma", | ||
| author_email="jer.bouma@gmail.com", | ||
| url="https://github.com/JerBouma/ThePassiveInvestor", | ||
| long_description=long_description, | ||
| long_description_content_type="text/markdown", | ||
| keywords=["passive", "investing", "finance", "etfs"], | ||
| classifiers=[ | ||
| "Development Status :: 5 - Production/Stable", | ||
| "Intended Audience :: Financial and Insurance Industry", | ||
| "Topic :: Office/Business :: Financial :: Investment", | ||
| "License :: OSI Approved :: MIT License", | ||
| "Operating System :: OS Independent", | ||
| "Programming Language :: Python :: 3" | ||
| ], | ||
| import setuptools | ||
|
|
||
| with open("README.md", "r") as fh: | ||
| long_description = fh.read() | ||
|
|
||
| setuptools.setup( | ||
| name="thepassiveinvestor", | ||
| packages=["thepassiveinvestor"], | ||
| version="1.0.10", | ||
| license="MIT", | ||
| description="Passive Investing for the Average Joe.", | ||
| author="JerBouma", | ||
| author_email="jer.bouma@gmail.com", | ||
| url="https://github.com/JerBouma/ThePassiveInvestor", | ||
| long_description=long_description, | ||
| long_description_content_type="text/markdown", | ||
| keywords=["passive", "investing", "finance", "etfs"], | ||
| classifiers=[ | ||
| "Development Status :: 5 - Production/Stable", | ||
| "Intended Audience :: Financial and Insurance Industry", | ||
| "Topic :: Office/Business :: Financial :: Investment", | ||
| "License :: OSI Approved :: MIT License", | ||
| "Operating System :: OS Independent", | ||
| "Programming Language :: Python :: 3" | ||
| ], | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,137 +1,139 @@ | ||
| import pandas as pd | ||
| import yfinance as yf | ||
| import os | ||
| from openpyxl import Workbook | ||
| from openpyxl.styles import Font, Alignment | ||
| from openpyxl.utils.dataframe import dataframe_to_rows | ||
|
|
||
| from .collect_data import collect_data | ||
| from .config import EMPTY_RISK_STATISTICS | ||
| from .utils import data_placer, image_placer, graph_placer | ||
|
|
||
|
|
||
| def create_ETF_report(tickers, filename, folder=None): | ||
| """ | ||
| Description | ||
| ---- | ||
| This function creates an Excel Report based on the tickers entered in the function. This function | ||
| only accepts ETFs and can not handle any other financial product. If other tickers are included, | ||
| by default no data is returned for that ticker. | ||
| Input | ||
| ---- | ||
| tickers (list or string) | ||
| A list of tickers or a single ticker from an ETF (i.e. VOO) | ||
| filename (string) | ||
| The name and location of the file you wish to save the data to. | ||
| folder (string, default is None) | ||
| If prefered, you can seperate filename and folder. | ||
| Output | ||
| ---- | ||
| Returns an Excel file with the given filename with data on each ticker. | ||
| """ | ||
| workbook = Workbook() | ||
| stock_data = yf.download(tickers, period='10y', progress=False)['Adj Close'] | ||
|
|
||
| if isinstance(tickers, str): | ||
| tickers = [tickers] | ||
|
|
||
| if isinstance(stock_data, pd.DataFrame): | ||
| stock_data = stock_data[tickers] | ||
| elif isinstance(stock_data, pd.Series): | ||
| stock_data = pd.DataFrame(stock_data) | ||
|
|
||
| if filename[-4:] not in ['xlsx', 'xlsm', 'xlsb']: | ||
| filename = f"{filename}.xlsx" | ||
| if folder is not None: | ||
| filename = os.path.join(folder, filename) | ||
|
|
||
| workbook.create_sheet(title='Stock Data') | ||
| stock_sheet = workbook['Stock Data'] | ||
|
|
||
| for row in dataframe_to_rows(stock_data, index=True, header=True): | ||
| stock_sheet.append(row) | ||
| stock_sheet.column_dimensions['A'].width = len(str(stock_data.index[0])) | ||
| stock_sheet.sheet_view.showGridLines = False | ||
|
|
||
| min_col, min_row, max_col = 1, 3, 1 | ||
|
|
||
| for ticker in tickers: | ||
| workbook.create_sheet(title=ticker) | ||
| sheet = workbook[ticker] | ||
| sheet.sheet_view.showGridLines = False | ||
|
|
||
| try: | ||
| ticker_data = collect_data(ticker) | ||
| except (KeyError, TypeError): | ||
| sheet['B2'].value = "No data available" | ||
| sheet['B2'].font = Font(italic=True) | ||
| continue | ||
|
|
||
| sheet['B2'].value = ticker_data['long_name'] | ||
| sheet['B2'].font = Font(bold=True, size=15) | ||
| sheet['B2'].alignment = Alignment(horizontal='left') | ||
| sheet.merge_cells('B2:M2') | ||
|
|
||
| sheet['B3'].value = ticker_data['summary'] | ||
| sheet['B3'].alignment = Alignment(wrap_text=True, vertical='center', horizontal='left') | ||
| sheet.merge_cells('B3:M3') | ||
| sheet.row_dimensions[3].height = 100 | ||
|
|
||
| sheet['B4'].value = "Sector Holdings" | ||
| sheet['B4'].font = Font(bold=True) | ||
|
|
||
| sheet['B17'].value = "Top Company Holdings" | ||
| sheet['B17'].font = Font(bold=True) | ||
|
|
||
| sheet['E19'].value = "Risk Statistics" | ||
| sheet['E19'].font = Font(bold=True) | ||
| sheet['E19'].alignment = Alignment(horizontal='center') | ||
| sheet.merge_cells('E19:J19') | ||
|
|
||
| sheet['L21'].value = "Last Five Annual Returns" | ||
| sheet['L21'].font = Font(bold=True) | ||
|
|
||
| sheet['L4'].value = 'Key Characteristics' | ||
| sheet['L4'].font = Font(bold=True) | ||
|
|
||
| data_placer(ticker_data['sector_holdings'], sheet, 5, 2, 'B', 'C') | ||
| data_placer(ticker_data['company_holdings'], sheet, 18, 2, 'B', 'C', | ||
| change_key_dimensions=False) | ||
| data_placer(ticker_data['annual_returns'], sheet, 22, 12, 'L', 'M', | ||
| change_key_dimensions=False, change_value_dimensions=False) | ||
| data_placer(ticker_data['key_characteristics'], sheet, 5, 12, 'L', 'M', | ||
| horizontal_alignment_value='left') | ||
|
|
||
| try: | ||
| data_placer(ticker_data['risk_data']['3y'], sheet, 20, 5, 'E', 'F', False, 'right', True, False) | ||
| except KeyError: | ||
| risk_data = EMPTY_RISK_STATISTICS | ||
| risk_data['year'] = '3y' | ||
| data_placer(ticker_data['risk_data'], sheet, 20, 5, 'E', 'F', False, 'right', True, False) | ||
| try: | ||
| data_placer(ticker_data['risk_data']['5y'], sheet, 20, 7, 'G', 'H', False, 'right', True, False) | ||
| except KeyError: | ||
| risk_data = EMPTY_RISK_STATISTICS | ||
| risk_data['year'] = '5y' | ||
| data_placer(ticker_data['risk_data'], sheet, 20, 7, 'G', 'H', False, 'right', True, False) | ||
| try: | ||
| data_placer(ticker_data['risk_data']['10y'], sheet, 20, 9, 'I', 'J', False, 'right', True, False) | ||
| except KeyError: | ||
| risk_data = EMPTY_RISK_STATISTICS | ||
| risk_data['year'] = '10y' | ||
| data_placer(ticker_data['risk_data'], sheet, 20, 9, 'I', 'J', False, 'right', True, False) | ||
|
|
||
| image_placer(ticker_data['image_URL'], sheet, 'L12') | ||
| graph_placer(stock_sheet, stock_data, sheet, min_col, min_row, max_col, "E4") | ||
| min_col += 1 | ||
| max_col += 1 | ||
|
|
||
| try: | ||
| workbook.remove(workbook['Sheet']) | ||
| except KeyError: | ||
| pass | ||
|
|
||
| stock_sheet.sheet_state = 'hidden' | ||
| workbook.save(filename) | ||
| import pandas as pd | ||
| import yfinance as yf | ||
| import os | ||
| from openpyxl import Workbook | ||
| from openpyxl.styles import Font, Alignment | ||
| from openpyxl.utils.dataframe import dataframe_to_rows | ||
|
|
||
| from .collect_data import collect_data | ||
| from .config import EMPTY_RISK_STATISTICS | ||
| from .utils import data_placer, image_placer, graph_placer | ||
|
|
||
|
|
||
| def create_ETF_report(tickers, filename, folder=None): | ||
| """ | ||
| Description | ||
| ---- | ||
| This function creates an Excel Report based on the tickers entered in the function. This function | ||
| only accepts ETFs and can not handle any other financial product. If other tickers are included, | ||
| by default no data is returned for that ticker. | ||
| Input | ||
| ---- | ||
| tickers (list or string) | ||
| A list of tickers or a single ticker from an ETF (i.e. VOO) | ||
| filename (string) | ||
| The name and location of the file you wish to save the data to. | ||
| folder (string, default is None) | ||
| If prefered, you can seperate filename and folder. | ||
| Output | ||
| ---- | ||
| Returns an Excel file with the given filename with data on each ticker. | ||
| """ | ||
| workbook = Workbook() | ||
| stock_data = yf.download(tickers, period='10y', progress=False)['Adj Close'] | ||
|
|
||
| if isinstance(tickers, str): | ||
| tickers = [tickers] | ||
|
|
||
| if isinstance(stock_data, pd.DataFrame): | ||
| stock_data = stock_data[tickers] | ||
| elif isinstance(stock_data, pd.Series): | ||
| stock_data = pd.DataFrame(stock_data) | ||
|
|
||
| if filename[-4:] not in ['xlsx', 'xlsm', 'xlsb']: | ||
| filename = f"{filename}.xlsx" | ||
| if folder is not None: | ||
| filename = os.path.join(folder, filename) | ||
|
|
||
| workbook.create_sheet(title='Stock Data') | ||
| stock_sheet = workbook['Stock Data'] | ||
|
|
||
| for row in dataframe_to_rows(stock_data, index=True, header=True): | ||
| stock_sheet.append(row) | ||
| stock_sheet.column_dimensions['A'].width = len(str(stock_data.index[0])) | ||
| stock_sheet.sheet_view.showGridLines = False | ||
|
|
||
| min_col, min_row, max_col = 1, 3, 1 | ||
|
|
||
| for ticker in tickers: | ||
| workbook.create_sheet(title=ticker) | ||
| sheet = workbook[ticker] | ||
| sheet.sheet_view.showGridLines = False | ||
|
|
||
| try: | ||
| ticker_data = collect_data(ticker) | ||
| except (KeyError, TypeError): | ||
| sheet['B2'].value = "No data available" | ||
| sheet['B2'].font = Font(italic=True) | ||
| continue | ||
|
|
||
| sheet['B2'].value = ticker_data['long_name'] | ||
| sheet['B2'].font = Font(bold=True, size=15) | ||
| sheet['B2'].alignment = Alignment(horizontal='left') | ||
| sheet.merge_cells('B2:M2') | ||
|
|
||
| sheet['B3'].value = ticker_data['summary'] | ||
| sheet['B3'].alignment = Alignment(wrap_text=True, vertical='center', horizontal='left') | ||
| sheet.merge_cells('B3:M3') | ||
| sheet.row_dimensions[3].height = 100 | ||
|
|
||
| sheet['B4'].value = "Sector Holdings" | ||
| sheet['B4'].font = Font(bold=True) | ||
|
|
||
| sheet['B17'].value = "Top Company Holdings" | ||
| sheet['B17'].font = Font(bold=True) | ||
|
|
||
| sheet['E19'].value = "Risk Statistics" | ||
| sheet['E19'].font = Font(bold=True) | ||
| sheet['E19'].alignment = Alignment(horizontal='center') | ||
| sheet.merge_cells('E19:J19') | ||
|
|
||
| sheet['L21'].value = "Last Five Annual Returns" | ||
| sheet['L21'].font = Font(bold=True) | ||
|
|
||
| sheet['L4'].value = 'Key Characteristics' | ||
| sheet['L4'].font = Font(bold=True) | ||
|
|
||
| data_placer(ticker_data['sector_holdings'], sheet, 5, 2, 'B', 'C', | ||
| value_formatting_style='percentage') | ||
| data_placer(ticker_data['company_holdings'], sheet, 18, 2, 'B', 'C', | ||
| change_key_dimensions=False, value_formatting_style='percentage') | ||
| data_placer(ticker_data['annual_returns'], sheet, 22, 12, 'L', 'M', | ||
| change_key_dimensions=False, change_value_dimensions=False, | ||
| value_formatting_style='percentage') | ||
| data_placer(ticker_data['key_characteristics'], sheet, 5, 12, 'L', 'M', | ||
| horizontal_alignment_value='left') | ||
|
|
||
| try: | ||
| data_placer(ticker_data['risk_data']['3y'], sheet, 20, 5, 'E', 'F', False, 'right', True, False) | ||
| except KeyError: | ||
| risk_data = EMPTY_RISK_STATISTICS | ||
| risk_data['year'] = '3y' | ||
| data_placer(ticker_data['risk_data'], sheet, 20, 5, 'E', 'F', False, 'right', True, False) | ||
| try: | ||
| data_placer(ticker_data['risk_data']['5y'], sheet, 20, 7, 'G', 'H', False, 'right', True, False) | ||
| except KeyError: | ||
| risk_data = EMPTY_RISK_STATISTICS | ||
| risk_data['year'] = '5y' | ||
| data_placer(ticker_data['risk_data'], sheet, 20, 7, 'G', 'H', False, 'right', True, False) | ||
| try: | ||
| data_placer(ticker_data['risk_data']['10y'], sheet, 20, 9, 'I', 'J', False, 'right', True, False) | ||
| except KeyError: | ||
| risk_data = EMPTY_RISK_STATISTICS | ||
| risk_data['year'] = '10y' | ||
| data_placer(ticker_data['risk_data'], sheet, 20, 9, 'I', 'J', False, 'right', True, False) | ||
|
|
||
| image_placer(ticker_data['image_URL'], sheet, 'L12') | ||
| graph_placer(stock_sheet, stock_data, sheet, min_col, min_row, max_col, "E4") | ||
| min_col += 1 | ||
| max_col += 1 | ||
|
|
||
| try: | ||
| workbook.remove(workbook['Sheet']) | ||
| except KeyError: | ||
| pass | ||
|
|
||
| stock_sheet.sheet_state = 'hidden' | ||
| workbook.save(filename) |
Oops, something went wrong.