Skip to content

Commit

Permalink
minor fixes & codecov improved
Browse files Browse the repository at this point in the history
  • Loading branch information
alvarob96 committed Oct 12, 2019
1 parent 213d66b commit e3bdfaf
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 19 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# investpy — a Python package for financial historical data extraction from Investing

investpy is a Python package to retrieve real-time historical data from [Investing](https://www.investing.com/).
It provides historical data retrieval from up to **29.628 STOCKS, 81.024 FUNDS, 11.366 ETFs, 1.889 CURRENCY CROSSES
and 7.797 INDICES from all over the world**. Basically, investpy allows you to download historical data from almost
It provides historical data retrieval from up to **29.628 stocks, 81.024 funds, 11.366 etfs, 1.889 currency crosses
and 7.797 indices**. Basically, investpy allows you to download historical data from almost
all the financial products indexed in Investing.com. All the data that can be retrieved includes data from all over the world,
from countries such as: **United States, France, India, Spain, Russia or Germany, amongst many others**. Therefore,
investpy is intended to wrap up all the available data from Investing.com, so that it can be retrieved via Python for
Expand Down Expand Up @@ -51,8 +51,8 @@ means that every other function is additional.
```python
import investpy

df = investpy.get_recent_data(stock='bbva',
country='spain')
df = investpy.get_stock_recent_data(stock='BBVA',
country='spain')
print(df.head())
```
```{r, engine='python', count_lines}
Expand All @@ -69,10 +69,10 @@ Date
```python
import investpy

df = investpy.get_historical_data(stock='bbva',
country='spain',
from_date='01/01/2010',
to_date='01/01/2019')
df = investpy.get_stock_historical_data(stock='BBVA',
country='spain',
from_date='01/01/2010',
to_date='01/01/2019')
print(df.head())
```
```{r, engine='python', count_lines}
Expand Down Expand Up @@ -119,6 +119,16 @@ as indexed in Investing.com.

All the functions definitions and usage can be found in the [Documentation](https://investpy.readthedocs.io/)!

## Utilites

Since investpy is just intended to retrieva data from different financial products as indexed in Investing.com,
the development of support modules is presented, which implement an additional functionallity based on investpy data.
Note that anyone can contribute to this section by creating any package, module or utility which uses this package. So on, the
ones already created are going to be presented, since they are intended to be used combined with investpy:

- [investpy_portfolio](https://github.com/alvarob96/investpy_portfolio/): is a Python package to generate stock portfolios.
- [trendet](https://github.com/alvarob96/trendet/): is a Python package for trend detection on stock time series data.

## Contribute - [![Open Source Helpers](https://www.codetriage.com/alvarob96/investpy/badges/users.svg)](https://www.codetriage.com/alvarob96/investpy)

As this is an open source project it is open to contributions, bug reports, bug fixes, documentation improvements,
Expand All @@ -127,10 +137,7 @@ enhancements and ideas.
Also there is an open tab of [issues](https://github.com/alvarob96/investpy/issues) where anyone can contribute opening
new issues if needed or navigate through them in order to solve them or contribute to its solving. Remember that issues
are not threads to describe multiple issues, this does not mean that issues can't be discussed, but if new issues are
reported, a new issue should be open so to keep a structured project management. Note that issues should be formatted as
the description specified in [ISSUE_TEMPLATE](https://github.com/alvarob96/investpy/tree/master/.github/ISSUE_TEMPLATE),
which is automatically launched whenever you want to open an issue, but if you prefer you can open a custom issue, trying
to give all the information to identify the issue and solve it if possible.
reported, a new issue should be open so to keep a structured project management.

Additionally, you can triage issues on [investpy CodeTriage](https://www.codetriage.com/alvarob96/investpy) so you can
provide issues so the package can grow and improve as the issues solves bugs, problems or needs, and maybe provide new
Expand Down
12 changes: 6 additions & 6 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Stock Data Retrieval
import investpy
df = investpy.get_recent_data(stock='bbva',
country='spain')
df = investpy.get_stock_recent_data(stock='bbva',
country='spain')
print(df.head())
Open High Low Close Volume Currency
Expand All @@ -35,10 +35,10 @@ Stock Data Retrieval
import investpy
df = investpy.get_historical_data(stock='bbva',
country='spain',
from_date='01/01/2010',
to_date='01/01/2019')
df = investpy.get_stock_historical_data(stock='bbva',
country='spain',
from_date='01/01/2010',
to_date='01/01/2019')
print(df.head())
Open High Low Close Volume Currency
Expand Down
7 changes: 6 additions & 1 deletion investpy/etfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,12 @@ def retrieve_etfs(test_mode=False):

results = list()

for country in countries['country'].tolist():
if test_mode is False:
country_list = countries['country'].tolist()
else:
country_list = ['spain', 'usa']

for country in country_list:
url = "https://www.investing.com/etfs/" + country.replace(" ", "-") + "-etfs?issuer_filter=0"

req = requests.get(url, headers=head)
Expand Down

0 comments on commit e3bdfaf

Please sign in to comment.