Skip to content

Commit 3c2718f

Browse files
committed
Add some info on exclude_exchanges
1 parent 17b44c1 commit 3c2718f

1 file changed

Lines changed: 7 additions & 9 deletions

File tree

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ industries, types of investments and much more.
1919
The aim of this database is explicitly _not_ to provide up-to-date fundamentals or stock data as those can be obtained
2020
with ease (with the help of this database) by using [yfinance](https://github.com/ranaroussi/yfinance),
2121
[FundamentalAnalysis](https://github.com/JerBouma/FundamentalAnalysis) or
22-
[ThePassiveInvestor](https://github.com/JerBouma/ThePassiveInvestor). Instead, it gives insights into the products
22+
[ThePassiveInvestor](https://github.com/JerBouma/ThePassiveInvestor). Instead, it gives insights into the products
2323
that exist in each country, industry and sector and gives the most essential information about each product. With
2424
this information, you can analyse specific areas of the financial world and/or find a product that is hard to find.
2525
See for examples on how you can combine this database, and the earlier mentioned packages the section
@@ -100,6 +100,9 @@ For users of the broker **DeGiro**, you are able to find data on the tickers fou
100100
`core_selection_degiro_filled` (all data) or `core_selection_degiro_filtered` (filtered by summary) as category
101101
when using the function `select_etfs`.
102102

103+
By default, exchanges are not included in the selection functions. Therefore, the amount of data returned is less
104+
than depicted in the key statistics. If you wish to include all exchanges, please set `exclude_exchanges` to `False`.
105+
103106
For additional information about each function you can use the build-in help function of Python. For
104107
example `help(show_options)` returns a general description, the possible input parameters and what is returned
105108
as output.
@@ -277,7 +280,7 @@ for symbol in airlines_us_fundamentals:
277280
plt.tight_layout()
278281
plt.show()
279282
``````
280-
Which results in the graph displayed below (as of the 14th of June 2021). From this graph you can identify
283+
Which results in the graph displayed below (as of the 18th of October 2021). From this graph you can identify
281284
companies that currently lack enough assets to cover their liabilities (quick ratio < 1), and those that do have
282285
enough assets (quick ratio > 1). Both too low and too high could make you wonder whether the company adequately
283286
manages its assets.
@@ -287,17 +290,12 @@ manages its assets.
287290
### Silicon Valley's Market Cap
288291
If I want to understand which listed technology companies exist in Silicon Valley, I can collect all equities of
289292
the sector 'Technology' and then filter based on city to obtain all listed technology companies in 'Silicon Valley'.
290-
The city 'San Jose' is where Silicon Valley is located. I remove all tickers with a dot since they refer to
291-
different markets.
293+
The city 'San Jose' is where Silicon Valley is located.
292294
````
293295
import FinanceDatabase as fd
294296

295297
all_technology_companies = fd.select_equities(sector='Technology')
296298
silicon_valley = fd.search_products(all_technology_companies, query='San Jose', search='city')
297-
298-
for ticker in silicon_valley.copy():
299-
if '.' in ticker:
300-
del silicon_valley[ticker]
301299
````
302300
Then I start collecting data with the [FundamentalAnalysis](https://github.com/JerBouma/FundamentalAnalysis) package.
303301
Here I collect the key metrics which include 57 different metrics (ranging from PE ratios to Market Cap).
@@ -407,7 +405,7 @@ consider creating an [Issue](https://github.com/JerBouma/FinanceDatabase/issues)
407405
Projects are bound to have (small) errors and can always be improved. Therefore, I highly encourage you to submit
408406
issues and create pull requests to improve the package.
409407
410-
The last update to the database is the 14th of June 2021. I always accept Pull Requests every few months
408+
The last update to the database is the 18th of October 2021. I always accept Pull Requests every few months
411409
to keep the database up to date. Extending the amount of tickers and data is also much appreciated. When you wish to do
412410
this, please inform me first to prevent multiple users doing the exact same thing.
413411

0 commit comments

Comments
 (0)