Skip to content

Commit a1e55ba

Browse files
JerBoumaJerBouma
committed
Update docstrings
1 parent c3ba4c9 commit a1e55ba

File tree

1 file changed

+83
-77
lines changed

1 file changed

+83
-77
lines changed

‎financetoolkit/toolkit_controller.py‎

Lines changed: 83 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1374,30 +1374,25 @@ def get_quote(self, progress_bar: bool | None = None):
13741374
13751375
Which returns:
13761376
1377-
| | TSLA | AAPL |
1378-
|:-----------------------|:-----------------------------|:-----------------------------|
1379-
| Symbol | TSLA | AAPL |
1380-
| Name | Tesla, Inc. | Apple Inc. |
1381-
| Price | 215.49 | 174.49 |
1382-
| Changes Percentage | -1.7015 | 0.2816 |
1383-
| Change | -3.73 | 0.49 |
1384-
| Day Low | 212.36 | 171.96 |
1385-
| Day High | 217.58 | 175.1 |
1386-
| Year High | 313.8 | 198.23 |
1387-
| Year Low | 101.81 | 124.17 |
1388-
| Market Capitalization | 682995534313 | 2744500935588 |
1389-
| Price Average 50 Days | 258.915 | 187.129 |
1390-
| Price Average 200 Days | 196.52345 | 161.4698 |
1391-
| Exchange | NASDAQ | NASDAQ |
1392-
| Volume | 136276584 | 61172150 |
1393-
| Average Volume | 133110158 | 57348456 |
1394-
| Open | 214.12 | 172.3 |
1395-
| Previous Close | 219.22 | 174 |
1396-
| EPS | 3.08 | 5.89 |
1397-
| PE | 69.96 | 29.62 |
1398-
| Earnings Announcement | 2023-10-17T20:00:00.000+0000 | 2023-10-25T10:59:00.000+0000 |
1399-
| Shares Outstanding | 3169499904 | 15728700416 |
1400-
| Timestamp | 2023-08-18 20:00:00 | 2023-08-18 20:00:01 |
1377+
| | TSLA | AAPL |
1378+
|:-----------------------|:--------------------|:---------------------|
1379+
| Symbol | TSLA | AAPL |
1380+
| Name | Tesla, Inc. | Apple Inc. |
1381+
| Price | 443.21 | 254.43 |
1382+
| Change % | 0.6380600000000001 | -0.40319000000000005 |
1383+
| Change | 2.81 | -1.03 |
1384+
| Volume | 78840639 | 39443231 |
1385+
| Day Low | 439.5 | 253.01 |
1386+
| Day High | 450.98 | 254.87 |
1387+
| Year High | 488.54 | 260.1 |
1388+
| Year Low | 212.11 | 169.21 |
1389+
| Market Capitalization | 1429511519286 | 3775840427700 |
1390+
| Price Average 50 Days | 354.2336 | 229.3156 |
1391+
| Price Average 200 Days | 334.7398 | 222.012 |
1392+
| Exchange | NASDAQ | NASDAQ |
1393+
| Open | 444.355 | 254.64 |
1394+
| Previous Close | 440.4 | 255.46 |
1395+
| Timestamp | 2025-09-29 20:00:00 | 2025-09-29 20:00:01 |
14011396
"""
14021397
if not self._api_key:
14031398
logger.error(
@@ -1467,19 +1462,18 @@ def get_rating(self, progress_bar: bool | None = None):
14671462
14681463
rating = toolkit.get_rating()
14691464
1470-
rating.loc['AMZN', 'Rating Recommendation'].tail()
1465+
rating.loc['AMZN'].tail()
14711466
```
14721467
14731468
Which returns:
14741469
1475-
| date | Rating Recommendation |
1476-
|:--------------------|:------------------------|
1477-
| 2023-08-01 00:00:00 | Strong Buy |
1478-
| 2023-08-02 00:00:00 | Strong Buy |
1479-
| 2023-08-03 00:00:00 | Strong Buy |
1480-
| 2023-08-04 00:00:00 | Strong Buy |
1481-
| 2023-08-07 00:00:00 | Strong Buy |
1482-
1470+
| date | Rating | Rating Score | DCF Score | ROE Score | ROA Score | DE Score | PE Score | PB Score |
1471+
|:--------------------|:---------|---------------:|------------:|------------:|------------:|-----------:|-----------:|-----------:|
1472+
| 2025-09-23 00:00:00 | B+ | 3 | 2 | 5 | 5 | 3 | 2 | 1 |
1473+
| 2025-09-24 00:00:00 | B+ | 3 | 2 | 5 | 5 | 3 | 2 | 1 |
1474+
| 2025-09-25 00:00:00 | B+ | 3 | 2 | 5 | 5 | 3 | 2 | 1 |
1475+
| 2025-09-26 00:00:00 | B+ | 3 | 2 | 5 | 5 | 3 | 2 | 1 |
1476+
| 2025-09-29 00:00:00 | B+ | 3 | 2 | 5 | 5 | 3 | 2 | 1 |
14831477
"""
14841478
if not self._api_key:
14851479
logger.error(
@@ -1549,37 +1543,37 @@ def get_analyst_estimates(
15491543
from financetoolkit import Toolkit
15501544
15511545
toolkit = Toolkit(
1552-
["AAPL", "MSFT", "GOOGL", "AMZN"], api_key="FINANCIAL_MODELING_PREP_KEY", start_date="2021-05-01", quarterly=False
1546+
["AAPL", "MSFT", "GOOGL", "AMZN"], api_key="FINANCIAL_MODELING_PREP_KEY", start_date="2024-05-01", quarterly=False
15531547
)
15541548
15551549
analyst_estimates = toolkit.get_analyst_estimates()
15561550
1557-
analyst_estimates.loc['AAPL']
1551+
analyst_estimates.loc['AAPL'].iloc[:, :5]
15581552
```
15591553
15601554
Which returns:
15611555
1562-
| | 2021 | 2022 | 2023 | 2024 |
1563-
|:------------------------------|-------------:|-------------:|-------------:|-------------:|
1564-
| Estimated Revenue Low | 2.98738e+11 | 3.07919e+11 | 3.3871e+11 | 2.93633e+11 |
1565-
| Estimated Revenue High | 4.48107e+11 | 4.61878e+11 | 5.08066e+11 | 4.4045e+11 |
1566-
| Estimated Revenue Average | 3.73422e+11 | 3.84898e+11 | 4.23388e+11 | 3.67042e+11 |
1567-
| Estimated EBITDA Low | 8.50991e+10 | 1.00742e+11 | 1.10816e+11 | 1.07415e+11 |
1568-
| Estimated EBITDA High | 1.27649e+11 | 1.51113e+11 | 1.66224e+11 | 1.61122e+11 |
1569-
| Estimated EBITDA Average | 1.06374e+11 | 1.25928e+11 | 1.3852e+11 | 1.34269e+11 |
1570-
| Estimated EBIT Low | 7.62213e+10 | 9.05428e+10 | 9.9597e+10 | 9.81566e+10 |
1571-
| Estimated EBIT High | 1.14332e+11 | 1.35814e+11 | 1.49396e+11 | 1.47235e+11 |
1572-
| Estimated EBIT Average | 9.52766e+10 | 1.13178e+11 | 1.24496e+11 | 1.22696e+11 |
1573-
| Estimated Net Income Low | 6.54258e+10 | 7.62265e+10 | 8.38492e+10 | 8.23371e+10 |
1574-
| Estimated Net Income High | 9.81387e+10 | 1.1434e+11 | 1.25774e+11 | 1.23506e+11 |
1575-
| Estimated Net Income Average | 8.17822e+10 | 9.52832e+10 | 1.04811e+11 | 1.02921e+11 |
1576-
| Estimated SGA Expense Low | 1.48491e+10 | 1.85317e+10 | 2.03848e+10 | 2.04857e+10 |
1577-
| Estimated SGA Expense High | 2.22737e+10 | 2.77975e+10 | 3.05772e+10 | 3.07286e+10 |
1578-
| Estimated SGA Expense Average | 1.85614e+10 | 2.31646e+10 | 2.5481e+10 | 2.56072e+10 |
1579-
| Estimated EPS Average | 4.26 | 5.465 | 6.01 | 6.2612 |
1580-
| Estimated EPS High | 5.12 | 6.56 | 7.21 | 7.5135 |
1581-
| Estimated EPS Low | 3.4 | 4.37 | 4.81 | 5.009 |
1582-
| Number of Analysts | 14 | 16 | 12 | 10 |
1556+
| | 2024 | 2025 | 2026 | 2027 | 2028 |
1557+
|:------------------------------|-------------:|-------------:|-------------:|-------------:|-------------:|
1558+
| Estimated Revenue Low | 3.89951e+11 | 4.06152e+11 | 4.29886e+11 | 4.61474e+11 | 4.55389e+11 |
1559+
| Estimated Revenue High | 3.9221e+11 | 4.19587e+11 | 4.5212e+11 | 4.63255e+11 | 5.05369e+11 |
1560+
| Estimated Revenue Average | 3.90481e+11 | 4.15035e+11 | 4.38728e+11 | 4.62364e+11 | 4.76309e+11 |
1561+
| Estimated EBITDA Low | 1.28061e+11 | 1.33382e+11 | 1.41176e+11 | 1.51549e+11 | 1.49551e+11 |
1562+
| Estimated EBITDA High | 1.28803e+11 | 1.37794e+11 | 1.48477e+11 | 1.52134e+11 | 1.65965e+11 |
1563+
| Estimated EBITDA Average | 1.28235e+11 | 1.36299e+11 | 1.4408e+11 | 1.51842e+11 | 1.56421e+11 |
1564+
| Estimated EBIT Low | 1.15692e+11 | 1.20498e+11 | 1.2754e+11 | 1.36911e+11 | 1.35106e+11 |
1565+
| Estimated EBIT High | 1.16362e+11 | 1.24484e+11 | 1.34136e+11 | 1.3744e+11 | 1.49934e+11 |
1566+
| Estimated EBIT Average | 1.15849e+11 | 1.23134e+11 | 1.30163e+11 | 1.37175e+11 | 1.41313e+11 |
1567+
| Estimated Net Income Low | 9.45908e+10 | 1.11489e+11 | 1.18544e+11 | 1.22161e+11 | 1.38181e+11 |
1568+
| Estimated Net Income High | 1.05866e+11 | 1.14578e+11 | 1.28409e+11 | 1.46962e+11 | 1.58172e+11 |
1569+
| Estimated Net Income Average | 9.7294e+10 | 1.13033e+11 | 1.23476e+11 | 1.25929e+11 | 1.46549e+11 |
1570+
| Estimated SGA Expense Low | 2.55838e+10 | 2.66468e+10 | 2.82039e+10 | 3.02763e+10 | 2.98771e+10 |
1571+
| Estimated SGA Expense High | 2.5732e+10 | 2.75282e+10 | 2.96626e+10 | 3.03931e+10 | 3.31562e+10 |
1572+
| Estimated SGA Expense Average | 2.56186e+10 | 2.72295e+10 | 2.8784e+10 | 3.03347e+10 | 3.12496e+10 |
1573+
| Estimated EPS Average | 6.7082 | 7.3761 | 8.0086 | 8.7606 | 9.5111 |
1574+
| Estimated EPS High | 6.8708 | 7.4362 | 8.3339 | 9.538 | 10.2655 |
1575+
| Estimated EPS Low | 6.139 | 7.2358 | 7.6936 | 7.9284 | 8.9681 |
1576+
| Number of Analysts | 25 | 29 | 30 | 19 | 9 |
15831577
"""
15841578
if not self._api_key:
15851579
logger.error(
@@ -1673,16 +1667,20 @@ def get_earnings_calendar(
16731667
16741668
Which returns:
16751669
1676-
| date | EPS | Estimated EPS | Revenue | Estimated Revenue | Fiscal Date Ending | Time |
1677-
|:------------|-------:|----------------:|--------------:|--------------------:|:---------------------|:-------|
1678-
| 2022-10-27 | 0.17 | 0.22 | 1.27101e+11 | nan | 2022-09-30 | amc |
1679-
| 2023-02-02 | 0.25 | 0.18 | 1.49204e+11 | 1.5515e+11 | 2022-12-31 | amc |
1680-
| 2023-04-27 | 0.31 | 0.21 | 1.27358e+11 | 1.24551e+11 | 2023-03-31 | amc |
1681-
| 2023-08-03 | 0.65 | 0.35 | 1.34383e+11 | 1.19573e+11 | 2023-06-30 | amc |
1682-
| 2023-10-25 | nan | 0.56 | nan | 1.41407e+11 | 2023-09-30 | amc |
1683-
| 2024-01-31 | nan | nan | nan | nan | 2023-12-30 | amc |
1684-
| 2024-04-25 | nan | nan | nan | nan | 2024-03-30 | amc |
1685-
| 2024-08-01 | nan | nan | nan | nan | 2024-06-30 | amc |
1670+
| date | EPS | Estimated EPS | Revenue | Estimated Revenue | Last Updated |
1671+
|:--------------------|------:|----------------:|------------:|--------------------:|:---------------|
1672+
| 2022-10-27 00:00:00 | 0.2 | 0.22 | 1.27101e+11 | 1.27308e+11 | 2025-04-25 |
1673+
| 2023-02-02 00:00:00 | 0.21 | 0.15 | 1.49204e+11 | 1.45713e+11 | 2025-04-25 |
1674+
| 2023-04-27 00:00:00 | 0.31 | 0.21 | 1.27358e+11 | 1.24551e+11 | 2025-04-25 |
1675+
| 2023-08-03 00:00:00 | 0.65 | 0.35 | 1.34383e+11 | 1.19573e+11 | 2025-04-25 |
1676+
| 2023-10-26 00:00:00 | 0.94 | 0.58 | 1.43083e+11 | 1.33393e+11 | 2025-04-25 |
1677+
| 2024-02-01 00:00:00 | 1 | 0.8 | 1.69961e+11 | 1.66172e+11 | 2025-04-25 |
1678+
| 2024-04-30 00:00:00 | 0.98 | 0.83 | 1.43313e+11 | 1.42654e+11 | 2025-04-25 |
1679+
| 2024-08-01 00:00:00 | 1.26 | 1.03 | 1.47977e+11 | 1.48665e+11 | 2025-04-25 |
1680+
| 2024-10-31 00:00:00 | 1.43 | 1.14 | 1.58877e+11 | 1.57275e+11 | 2025-04-25 |
1681+
| 2025-02-06 00:00:00 | 1.86 | 1.49 | 1.87792e+11 | 1.87337e+11 | 2025-05-06 |
1682+
| 2025-05-01 00:00:00 | 1.59 | 1.37 | 1.55667e+11 | 1.55148e+11 | 2025-08-01 |
1683+
| 2025-07-31 00:00:00 | 1.68 | 1.31 | 1.67702e+11 | 1.61776e+11 | 2025-09-30 |
16861684
"""
16871685
if not self._api_key:
16881686
logger.error(
@@ -2375,13 +2373,21 @@ def get_dividend_calendar(
23752373
23762374
Which returns:
23772375
2378-
| date | Adj Dividend | Dividend | Record Date | Payment Date | Declaration Date |
2379-
|:-----------|---------------:|-----------:|:--------------|:---------------|:-------------------|
2380-
| 2022-08-05 | 0.23 | 0.23 | 2022-08-08 | 2022-08-11 | 2022-07-28 |
2381-
| 2022-11-04 | 0.23 | 0.23 | 2022-11-07 | 2022-11-10 | 2022-10-27 |
2382-
| 2023-02-10 | 0.23 | 0.23 | 2022-12-28 | 2023-02-16 | 2022-12-19 |
2383-
| 2023-05-12 | 0.24 | 0.24 | 2023-05-15 | 2023-05-18 | 2023-05-04 |
2384-
| 2023-08-11 | 0.24 | 0.24 | 2023-08-14 | 2023-08-17 | 2023-08-03 |
2376+
| date | Adj Dividend | Dividend | Yield | Record Date | Payment Date | Declaration Date |
2377+
|:-----------|---------------:|-----------:|--------:|:--------------|:---------------|:-------------------|
2378+
| 2022-08-05 | 0.23 | 0.23 | 0.5443 | 2022-08-08 | 2022-08-11 | 2022-07-28 |
2379+
| 2022-11-04 | 0.23 | 0.23 | 0.6576 | 2022-11-07 | 2022-11-10 | 2022-10-27 |
2380+
| 2023-02-10 | 0.23 | 0.23 | 0.6092 | 2023-02-13 | 2023-02-16 | 2023-02-02 |
2381+
| 2023-05-12 | 0.24 | 0.24 | 0.5389 | 2023-05-15 | 2023-05-18 | 2023-05-04 |
2382+
| 2023-08-11 | 0.24 | 0.24 | 0.5287 | 2023-08-14 | 2023-08-17 | 2023-08-03 |
2383+
| 2023-11-10 | 0.24 | 0.24 | 0.5097 | 2023-11-13 | 2023-11-16 | 2023-11-02 |
2384+
| 2024-02-09 | 0.24 | 0.24 | 0.5083 | 2024-02-12 | 2024-02-15 | 2024-02-01 |
2385+
| 2024-05-10 | 0.25 | 0.25 | 0.5299 | 2024-05-13 | 2024-05-16 | 2024-05-02 |
2386+
| 2024-08-12 | 0.25 | 0.25 | 0.4505 | 2024-08-12 | 2024-08-15 | 2024-08-01 |
2387+
| 2024-11-08 | 0.25 | 0.25 | 0.4362 | 2024-11-11 | 2024-11-14 | 2024-10-31 |
2388+
| 2025-02-10 | 0.25 | 0.25 | 0.4393 | 2025-02-10 | 2025-02-13 | 2025-01-30 |
2389+
| 2025-05-12 | 0.26 | 0.26 | 0.4791 | 2025-05-12 | 2025-05-15 | 2025-05-01 |
2390+
| 2025-08-11 | 0.26 | 0.26 | 0.449 | 2025-08-11 | 2025-08-14 | 2025-07-31 |
23852391
"""
23862392
if not self._api_key:
23872393
logger.error(
@@ -2500,10 +2506,10 @@ def get_esg_scores(
25002506
25012507
| date | Environmental Score | Social Score | Governance Score | ESG Score |
25022508
|:-------|----------------------:|---------------:|-------------------:|------------:|
2503-
| 2022Q3 | 72.42 | 58.39 | 61.13 | 63.98 |
2504-
| 2022Q4 | 72.22 | 58.05 | 61.27 | 63.85 |
2505-
| 2023Q1 | 72.6 | 58.74 | 61.88 | 64.41 |
2506-
| 2023Q2 | 73.54 | 60.73 | 63.44 | 65.9 |
2509+
| 2022 | 73.03 | 58.66 | 61.4 | 64.37 |
2510+
| 2023 | 72.89 | 58.16 | 60.65 | 63.9 |
2511+
| 2024 | 72.53 | 58.08 | 60.7 | 63.77 |
2512+
| 2025 | 71.85 | 57.64 | 59.62 | 63.04 |
25072513
"""
25082514
if not self._api_key:
25092515
logger.error(

0 commit comments

Comments
 (0)