Skip to content

Commit d83fb39

Browse files
committed
Grammar and addition to show_options
1 parent f7ec9a6 commit d83fb39

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ with ease (with the help of this database) by using [FundamentalAnalysis](https:
1414
or [yfinance](https://github.com/ranaroussi/yfinance). Instead, it gives insights into the products that exist in each
1515
country, industry and sector and gives the most essential information about each product. With this information, you
1616
can analyse specific areas of the financial world and/or find that product that is hard to find. See for examples
17-
on how you can combine this database and the earlier mentioned packages the section [Examples](#Examples).
17+
on how you can combine this database, and the earlier mentioned packages the section [Examples](#Examples).
1818

1919
Some key statistics of the database:
2020

@@ -38,7 +38,7 @@ Some key statistics of the database:
3838
or by manual search.
3939

4040
## Usage
41-
To access the database you can download the entire repository but I strongly recommend making use of the package
41+
To access the database you can download the entire repository, but I strongly recommend making use of the package
4242
closely attached to the database. It allows you to select specific json files as well as search through collected
4343
data with a specific query.
4444

@@ -48,8 +48,9 @@ You can install the package with the following steps:
4848
2. (within Python) `import FinanceDatabase as fd`
4949

5050
The package has the following functions:
51-
- `show_options(product)` - gives all available options from the below functions per product (i.e. Equities, Funds)
52-
which then can be used to collect the data.
51+
- `show_options(product, equities_selection=None)` - gives all available options from the below functions per
52+
product (i.e. Equities, Funds) which then can be used to collect the data. You can select a sub selection of
53+
equities by entering 'countries', 'sectors' or 'industries' for equities_selection.
5354
- `select_cryptocurrencies(cryptocurrency=None)` - with no input gives all cryptocurrencies, with input gives
5455
the cryptocurrency of choice.
5556
- `select_currencies(currency=None)` - with no input gives all currencies, with input gives
@@ -60,15 +61,15 @@ specific category.
6061
gives all equities of a country, sector, industry or a combination of the three.
6162
- `select_funds(category=None)` - with no input gives all funds, with input gives all funds of a
6263
specific category.
63-
- `def select_indices(market=None)` - with no input gives all indices, with input gives all funds of a
64+
- `select_indices(market=None)` - with no input gives all indices, with input gives all funds of a
6465
specific market which usually refers to indices in a specific country (like de_market gives DAX).
6566
- `select_other(product)` - gives either all Futures, all Moneymarkets or all Options.
6667
- `search_products(database, query, new_database=None)` - with input from the above functions, this function searching
6768
for specific values in the summary of the product (i.e. the query 'sustainable')
6869

6970
## Examples
7071
This section gives a few examples of the possibilities with this package. These are merely a few of the things you
71-
can do with the package and it only uses yfinance. **As you can obtain a wide range of symbols, pretty much any package
72+
can do with the package, and it only uses yfinance. **As you can obtain a wide range of symbols, pretty much any package
7273
that requires symbols should work.**
7374

7475
### United States' Airlines
@@ -110,7 +111,7 @@ plt.tight_layout()
110111
plt.show()
111112
``````
112113
Which results in the graph displayed below (as of the 3rd of February 2021). From this graph you could identify
113-
companies that currently lack enough assets to cover their liabilities (quick ratio < 1) and those that do have enough
114+
companies that currently lack enough assets to cover their liabilities (quick ratio < 1), and those that do have enough
114115
assets (quick ratio > 1). Both too low and too high could make you wonder whether the company adequately manages
115116
its assets.
116117
@@ -133,7 +134,7 @@ for symbol in semiconductor_etfs:
133134
semiconductor_etfs_fundamentals[symbol] = get_json("https://finance.yahoo.com/quote/" + symbol)
134135
````
135136
And lastly, I have a look at the YTD returns (as of the 3rd of February 2021) of each ETF to understand which ones
136-
might be worthwile to invest in:
137+
might be outperforming the others:
137138
````
138139
for symbol in semiconductor_etfs_fundamentals:
139140
ytd_return = semiconductor_etfs_fundamentals[symbol]['fundPerformance']['trailingReturns']['ytd']
@@ -148,14 +149,14 @@ plt.tight_layout()
148149
plt.xticks([-1, -0.5, 0, 0.5, 1], ['-100%', '-50%', '0%', '50%', '100%'])
149150
plt.show()
150151
````
151-
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
152-
figure out how each ETF differs and what might be worthwile to invest in.
152+
This results in the following graph which gives _some_ insights in the available semiconductor ETFs. Then with the
153+
large amount of fundamentals data you can figure out how each ETF differs and what might be worthwhile to invest in.
153154
154155
![FinanceDatabase](Examples/Semiconductors_ETFs_Returns.png)
155156
156157
## Contribution
157158
Projects are bound to have (small) errors and can always be improved. Therefore, I highly encourage you to submit
158159
issues and create pull requests to improve the package.
159160
160-
The last update to the database is the 3rd of February 2021. I do always accept Pull Requests every few months
161+
The last update to the database is the 3rd of February 2021. I always accept Pull Requests every few months
161162
to keep the database up to date. Extending the amount of tickers and data is also much appreciated.

0 commit comments

Comments
 (0)