Skip to content

Commit

Permalink
Add in proper exampels
Browse files Browse the repository at this point in the history
  • Loading branch information
JerBouma committed Sep 3, 2023
1 parent d085ce7 commit 9c3f591
Show file tree
Hide file tree
Showing 7 changed files with 5,347 additions and 142 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ PyPi Build/
Tests/*.html
.DS_Store
*.ipynb
!examples.ipynb
!examples/*.ipynb
!compression.ipynb

# C extensions
Expand Down
324 changes: 204 additions & 120 deletions README.md

Large diffs are not rendered by default.

29 changes: 9 additions & 20 deletions examples.ipynb → ...nance Database - 1. Getting Started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,12 @@
"<p align=\"center\">\n",
" <img src=\"https://user-images.githubusercontent.com/46355364/220746807-669cdbc1-ac67-404c-b0bb-4a3d67d9931f.jpg\" alt=\"Logo\">\n",
"</center>\n",
"<p align=\"center\">\n",
" <a href=\"https://www.buymeacoffee.com/jerbouma\">\n",
" <img src=\"https://img.shields.io/badge/Buy%20Me%20A%20Coffee-Donate-brightgreen?logo=buymeacoffee\" alt=\"Logo\">\n",
" </a>\n",
" <a href=\"https://github.com/JerBouma/FinanceDatabase/issues\">\n",
" <img src=\"https://img.shields.io/github/issues/jerbouma/financedatabase\" alt=\"Logo\">\n",
" </a>\n",
" <a href=\"https://github.com/JerBouma/FinanceDatabase/pulls\">\n",
" <img src=\"https://img.shields.io/github/issues-pr/JerBouma/FinanceDatabase?color=yellow\" alt=\"Logo\">\n",
" </a>\n",
" <a href=\"https://pypi.org/project/financedatabase/\">\n",
" <img src=\"https://img.shields.io/pypi/v/FinanceDatabase\" alt=\"Logo\">\n",
" </a>\n",
" <a href=\"https://pypi.org/project/financedatabase/\">\n",
" <img src=\"https://img.shields.io/pypi/dm/FinanceDatabase\" alt=\"Logo\">\n",
" </a>\n",
"</center>\n",
"\n",
"[![GitHub Sponsors](https://img.shields.io/badge/Sponsor_this_Project-grey?logo=github)](https://github.com/sponsors/JerBouma)\n",
"[![Documentation](https://img.shields.io/badge/Documentation-grey?logo=readme)](https://www.jeroenbouma.com/projects/financedatabase)\n",
"[![Supported Python Versions](https://img.shields.io/pypi/pyversions/financedatabase)](https://pypi.org/project/financedatabase/)\n",
"[![PYPI Version](https://img.shields.io/pypi/v/financedatabase)](https://pypi.org/project/financedatabase/)\n",
"[![PYPI Downloads](https://static.pepy.tech/badge/financedatabase/month)](https://pepy.tech/project/financedatabase)\n",
"\n",
"The **FinanceDatabase** serves the role of providing anyone with any type of financial product categorisation entirely for free. To be able to achieve this, the FinanceDatabase relies on involvement from the community to add, edit and remove tickers over time. This is made easy enough that anyone, even with a lack of coding experience can contribute because of the usage of CSV files that can be manually edited. I'd like to invite you to go to the **[Contributing Guidelines](https://github.com/JerBouma/FinanceDatabase/blob/main/CONTRIBUTING.md)** to understand how you can help. Thank you!\n",
"\n",
Expand All @@ -40,7 +29,7 @@
"industries, types of investments and much more.\n",
"\n",
"The aim of this database is explicitly _not_ to provide up-to-date fundamentals or stock data as those can be obtained \n",
"with ease (with the help of this database) by using [yfinance](https://github.com/ranaroussi/yfinance) or [FundamentalAnalysis](https://github.com/JerBouma/FundamentalAnalysis). Instead, it gives insights into the products \n",
"with ease (with the help of this database) by using the [FinanceToolkit](https://github.com/JerBouma/FinanceToolkit). Instead, it gives insights into the products \n",
"that exist in each country, industry and sector and gives the most essential information about each product. With \n",
"this information, you can analyse specific areas of the financial world and/or find a product that is hard to find.\n"
]
Expand Down Expand Up @@ -1081,7 +1070,7 @@
" </tr>\n",
" </tbody>\n",
"</table>\n",
"<p>22905 rows × 19 columns</p>\n",
"<p>22922 rows × 19 columns</p>\n",
"</div>"
],
"text/plain": [
Expand Down Expand Up @@ -1197,7 +1186,7 @@
"NaN NaN NaN NaN \n",
"NaN NaN NaN NaN \n",
"\n",
"[22905 rows x 19 columns]"
"[22922 rows x 19 columns]"
]
},
"execution_count": 13,
Expand Down
Loading

0 comments on commit 9c3f591

Please sign in to comment.