financedatabase 0.1.0__py3-none-any.whl

FinanceDatabase-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jeroen Bouma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

FinanceDatabase-0.1.0.dist-info/METADATA

@@ -0,0 +1,175 @@
+Metadata-Version: 2.1
+Name: FinanceDatabase
+Version: 0.1.0
+Summary: This is a database of 180.000+ symbols containing Equities, ETFs, Funds, Indices, Futures, Options, Currencies, Cryptocurrencies and Money Markets.
+Home-page: https://github.com/JerBouma/FinanceDatabase
+Author: JerBouma
+Author-email: jer.bouma@gmail.com
+License: MIT
+Keywords: finance,database,financials
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+
+# Finance Database
+As a private investor, the sheer amount of information that can be found on the internet is rather daunting. Trying to 
+understand what type of companies or ETFs are available is incredibly challenging with there being millions of
+companies amd derivatives available on the market. Sure, the most traded companies and ETFs can quickly be found
+simply because they are known to the public (for example, Microsoft, Tesla, S&P500 ETF or an All-World ETF). However, 
+what else is out there is often unknown.
+
+**This database tries to solve that**. It features 180.000+ symbols containing Equities, ETFs, Funds, Indices, Futures, 
+Options, Currencies, Cryptocurrencies and Money Markets. It therefore allows you to obtain a broad overview of sectors,
+industries, types of investments and much more.
+
+The aim of this database is explicitly _not_ to provide up-to-date fundamentals or stock data as those can be obtained 
+with ease (with the help of this database) by using [FundamentalAnalysis](https://github.com/JerBouma/FundamentalAnalysis) 
+or [yfinance](https://github.com/ranaroussi/yfinance). Instead, it gives  insights into the products that exist in each 
+country, industry and sector and gives the most essential information about each product. With this information, you 
+can analyse specific areas of the financial world and/or find that product that is hard to find. See for examples
+on how you can combine this database and the earlier mentioned packages the section [Examples](#Examples).
+
+Some key statistics of the database:
+
+| Product           | Quantity  | Sectors   | Industries    | Countries | Exchanges |
+| ----------------- | --------- | --------- | ------------- | --------- | --------- |
+| Equities          | 84.091    | 16        | 262           | 109       | 79        |
+| ETFs              | 15.892    | 268*      | 88*           | 100**     | 44        |
+| Funds             | 34.947    | 857*      | 416*          | 100**     | 25        |
+
+| Product           | Quantity  | Exchanges |
+| ----------------- | --------- | --------- |
+| Indices           | 24.548    | 62        |
+| Currencies        | 2.529     | 2         |
+| Cryptocurrencies  | 3.624     | 1         |
+| Options           | 13.819    | 1         |
+| Futures           | 1.173     | 7         |
+| Money Markets     | 1.384     | 2         |
+
+\* These numbers refer to families (iShares, Vanguard) and categories (World Stock, Real Estate) respectively.  
+\** This is an estimation. Obtaining the country distribution can only be done by collecting data on the underlying 
+or by manual search.
+
+## Usage
+To access the database you can download the entire repository but I strongly recommend making use of the package 
+closely attached to the database. It allows you to select specific json files as well as search through collected
+data with a specific query.
+
+You can install the package with the following steps:
+1. `pip install FinanceDatabase`
+    - Alternatively, download the 'Searcher' directory.
+2. (within Python) `import FinanceDatabase as fd`
+
+The package has the following functions:
+- `show_options(product)` - gives all available options from the below functions per product (i.e. Equities, Funds)
+which then can be used to collect the data.
+- `select_cryptocurrencies(cryptocurrency=None)` - with no input gives all cryptocurrencies, with input gives 
+the cryptocurrency of choice.
+- `select_currencies(currency=None)` - with no input gives all currencies, with input gives 
+the currency of choice.
+- `select_etfs(category=None)` - with no input gives all etfs, with input gives all etfs of a 
+specific category.
+- `select_equities(country=None, sector=None, industry=None)` - with no input gives all equities, with input 
+gives all equities of a country, sector, industry or a combination of the three.
+- `select_funds(category=None)` - with no input gives all funds, with input gives all funds of a 
+specific category.
+- `def select_indices(market=None)` - with no input gives all indices, with input gives all funds of a 
+specific market which usually refers to indices in a specific country (like de_market gives DAX).
+- `select_other(product)` - gives either all Futures, all Moneymarkets or all Options.
+- `search_products(database, query, new_database=None)` - with input from the above functions, this function searching
+for specific values in the summary of the product (i.e. the query 'sustainable')
+
+## Examples
+This section gives a few examples of the possibilities with this package. These are merely a few of the things you
+can do with the package and it only uses yfinance. **As you can obtain a wide range of symbols, pretty much any package 
+that requires symbols should work.**
+
+### United States' Airlines
+If I wish to obtain all companies within the United States listed under 'Airlines' I can write the 
+following code:
+````
+import FinanceDatabase as fd
+
+airlines_us = fd.select_equities(country='United States', sector='Industrials', industry='Airlines')
+````
+Then, I can use packages like [yfinance](https://github.com/ranaroussi/yfinance) to quickly collect data from 
+Yahoo Finance for each symbol in the industry like this:
+````
+from yfinance.utils import get_json
+from yfinance import download
+
+airlines_us_fundamentals = {}
+for symbol in airlines_us:
+    airlines_us_fundamentals[symbol] = get_json("https://finance.yahoo.com/quote/" + symbol)
+
+airlines_us_stock_data = download(list(airlines_us))
+```` 
+With a few lines of code, I have collected all data from a specific industry within the United States. From here on 
+you can compare pretty much any key statistic, fundamental data and stock data. For example, let's plot a simple bar 
+chart that gives insights in the Quick Ratios (indicator of the overall financial strength or weakness of a company):
+````
+import matplotlib.pyplot as plt
+
+for symbol in airlines_us_fundamentals:
+    quick_ratio = airlines_us_fundamentals[symbol]['financialData']['quickRatio']
+    long_name = airlines_us_fundamentals[symbol]['quoteType']['longName']
+
+    if quick_ratio is None:
+        continue
+
+    plt.barh(long_name, quick_ratio)
+
+plt.tight_layout()
+plt.show()
+``````
+Which results in the graph displayed below (as of the 3rd of February 2021). From this graph you could identify 
+companies that currently lack enough assets to cover their liabilities (quick ratio < 1) and those that do have enough
+assets (quick ratio > 1). Both too low and too high could make you wonder whether the company adequately manages 
+its assets.
+
+![FinanceDatabase](Examples/United_States_Airlines_QuickRatio.png)
+
+### Semiconductors ETFs
+If I wish to obtain all ETFs that have something to do with 'semiconductors' I can use the search function which works
+as follows:
+````
+import FinanceDatabase as fd
+
+all_etfs = fd.select_etfs()
+semiconductor_etfs = search_products(all_etfs, 'semiconductor')
+````
+The variable semiconductor_etfs returns all etfs that have the word 'semiconductor' in their summary which usually also 
+corresponds to the fact they are targeted around semiconductors. Next, I collect data:
+````
+semiconductor_etfs_fundamentals = {}
+for symbol in semiconductor_etfs:
+    semiconductor_etfs_fundamentals[symbol] = get_json("https://finance.yahoo.com/quote/" + symbol)
+````
+And lastly, I have a look at the YTD returns (as of the 3rd of February 2021) of each ETF to understand which ones 
+might be worthwile to invest in:
+````
+for symbol in semiconductor_etfs_fundamentals:
+    ytd_return = semiconductor_etfs_fundamentals[symbol]['fundPerformance']['trailingReturns']['ytd']
+    long_name = semiconductor_etfs_fundamentals[symbol]['quoteType']['longName']
+
+    if ytd_return is None:
+        continue
+
+    plt.barh(long_name, ytd_return)
+
+plt.tight_layout()
+plt.xticks([-1, -0.5, 0, 0.5, 1], ['-100%', '-50%', '0%', '50%', '100%'])
+plt.show()
+````
+This results in the following graph which gives _some_ insights in the available semiconductor ETFs. Then with the large amount of fundamentals data you can 
+figure out how each ETF differs and what might be worthwile to invest in.
+
+![FinanceDatabase](Examples/Semiconductors_ETFs_Returns.png)
+
+
+

FinanceDatabase-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+Searcher/__init__.py,sha256=SQZsYUKL1Imdm8E3bzAq4s9yZBdND_9uZ-sAfgzFWtA,387
+Searcher/json_options.py,sha256=K4vhI3sqwSf8NWI50OlpAH1mE53jYu3IEKnKXszEHA8,1159
+Searcher/json_picker.py,sha256=4i6heSaxpaNLDAputUW9LomaYQHSkNria007nIdq2l4,6805
+FinanceDatabase-0.1.0.dist-info/LICENSE,sha256=ZAOE27yAFlghnUI41yF3PcGqCAf00STEm7yIAjgb-j8,1090
+FinanceDatabase-0.1.0.dist-info/METADATA,sha256=N1sy0ZaKQfzCOIoaomhcgs8jA9Qzjsoo-9RKt9PT_lY,8910
+FinanceDatabase-0.1.0.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
+FinanceDatabase-0.1.0.dist-info/top_level.txt,sha256=fcQge8j8kNtCcDPgmW1D6HEWo7a7cAQlq2quar7UEfc,9
+FinanceDatabase-0.1.0.dist-info/RECORD,,

FinanceDatabase-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.36.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

FinanceDatabase-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+Searcher

Searcher/__init__.py

@@ -0,0 +1,10 @@
+# Modules
+from .json_picker import select_cryptocurrencies
+from .json_picker import select_currencies
+from .json_picker import select_etfs
+from .json_picker import select_equities
+from .json_picker import select_funds
+from .json_picker import select_indices
+from .json_picker import select_other
+from .json_options import show_options
+from .json_options import search_products

Searcher/json_options.py

@@ -0,0 +1,33 @@
+import requests
+import json
+
+
+def show_options(product):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Categories/")
+
+    if product.lower() not in ['cryptocurrencies', 'currencies', 'equities', 'etfs', 'funds']:
+        raise ValueError((product.lower() + " is not an available options. Please choose either 'cryptocurrencies', "
+                                            "'currencies', 'equities', 'etfs' or 'funds'"))
+    try:
+        json_file = URL + product.lower() + '_options.json'
+        request = requests.get(json_file)
+        json_data = json.loads(request.text)
+    except json.decoder.JSONDecodeError:
+        raise ValueError("Not able to find the options for " + product.lower())
+
+    return json_data
+
+
+def search_products(database, query, new_database=None):
+    if new_database is None:
+        new_database = {}
+
+    for symbol in database:
+        try:
+            if query in database[symbol]['summary']:
+                new_database[symbol] = database[symbol]
+        except (TypeError, KeyError):
+            continue
+
+    return new_database

Searcher/json_picker.py

@@ -0,0 +1,181 @@
+import requests
+import json
+
+
+def select_cryptocurrencies(cryptocurrency=None):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Cryptocurrencies/")
+
+    if cryptocurrency:
+        try:
+            json_file = URL + cryptocurrency + '.json'
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data for {}".format(cryptocurrency))
+    else:
+        try:
+            json_file = URL + "_Cryptocurrencies.json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data.")
+
+    return json_data
+
+
+def select_currencies(currency=None):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Currencies/")
+
+    if currency:
+        try:
+            json_file = URL + currency + '.json'
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data for {}".format(currency))
+    else:
+        try:
+            json_file = URL + "_Currencies.json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data.")
+
+    return json_data
+
+
+def select_etfs(category=None):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/ETFs/")
+
+    if category:
+        category = category.replace(' ', '%20')
+        try:
+            json_file = URL + category + '.json'
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data for {}".format(category))
+    else:
+        try:
+            json_file = URL + "_ETFs.json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data.")
+
+    return json_data
+
+
+def select_equities(country=None, sector=None, industry=None):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Equities/")
+
+    if country and sector and industry:
+        country = country.replace(' ', '%20')
+        sector = sector.replace(' ', '%20')
+        industry = industry.replace(' ', '%20')
+
+        try:
+            json_file = URL + 'Countries/' + country + '/' + sector + '/' + industry + ".json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data with the combination of Country ({}), "
+                             "Sector ({}), Industry ({}).".format(country, sector, industry))
+    elif sector and industry:
+        sector = sector.replace(' ', '%20')
+        industry = industry.replace(' ', '%20')
+
+        try:
+            json_file = URL + 'Sectors/' + sector + '/' + industry + ".json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data with the combination of, "
+                             "Sector ({}), Industry ({}).".format(sector, industry))
+    elif country:
+        country = country.replace(' ', '%20')
+
+        try:
+            json_file = URL + 'Countries/' + country + ".json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data with the combination of "
+                             "Country ({}).".format(country))
+    elif industry or (country and industry):
+        raise ValueError("Only selecting industry or country and industry results in no data.")
+    else:
+        try:
+            json_file = URL + "Equities.json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data.")
+
+    return json_data
+
+
+def select_funds(category=None):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Funds/")
+
+    if category:
+        category = category.replace(' ', '%20')
+        try:
+            json_file = URL + category + '.json'
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data for {}".format(category))
+    else:
+        try:
+            json_file = URL + "_Funds.json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data.")
+
+    return json_data
+
+
+def select_indices(market=None):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Indices/")
+
+    if market:
+        try:
+            json_file = URL + market + '.json'
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data for {}".format(market))
+    else:
+        try:
+            json_file = URL + "_Indices.json"
+            request = requests.get(json_file)
+            json_data = json.loads(request.text)
+        except json.decoder.JSONDecodeError:
+            raise ValueError("Not able to find any data.")
+
+    return json_data
+
+
+def select_other(product):
+    URL = ("https://raw.githubusercontent.com/JerBouma/FinanceDatabase/master/"
+           "Database/Other/")
+
+    if product not in ['Futures', 'Moneymarkets', 'Options']:
+        raise ValueError("{} is not available. Only 'Futures', 'Moneymarkets' and 'Options'.")
+
+    try:
+        json_file = URL + product + ".json"
+        request = requests.get(json_file)
+        json_data = json.loads(request.text)
+    except json.decoder.JSONDecodeError:
+        raise ValueError("Not able to find any data with type {}.".format(product))
+
+    return json_data