Skip to content

Commit 65457ec

Browse files
author
alvarobartt
committed
fixed README indents for readability (dev)
1 parent ff8f0ab commit 65457ec

File tree

1 file changed

+59
-20
lines changed

1 file changed

+59
-20
lines changed

README.md

Lines changed: 59 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,24 @@
44

55
<h2 align="center">Financial Data Extraction from Investing.com with Python</h2>
66

7-
investpy is a Python package to retrieve data from [Investing.com](https://www.investing.com/), which provides **data retrieval from up to: 39952 stocks, 82221 funds, 11403 etfs, 2029 currency crosses, 7797 indices, 688 bonds, 66 commodities, 250 certificates and 2812 cryptocurrencies**.
7+
investpy is a Python package to retrieve data from [Investing.com](https://www.investing.com/), which provides **data retrieval from
8+
up to: 39952 stocks, 82221 funds, 11403 etfs, 2029 currency crosses, 7797 indices, 688 bonds, 66 commodities, 250 certificates and
9+
2812 cryptocurrencies**.
810

9-
investpy allows the user to download both recent and historical data from all the financial products indexed at Investing.com. **It includes data from all over the world**, from countries such as: United States, France, India, Spain, Russia or Germany, amongst many others.
11+
investpy allows the user to download both recent and historical data from all the financial products indexed at Investing.com.
12+
**It includes data from all over the world**, from countries such as: United States, France, India, Spain, Russia or Germany,
13+
amongst many others.
1014

11-
investpy seeks to be one of the most complete Python packages when it comes to financial data extraction in order to stop relying on public/private APIs, since investpy is **FREE** and has **NO LIMITATIONS**. These are some of the features that currently lead investpy to be one of the most consistent packages when it comes to financial data retrieval.
15+
investpy seeks to be one of the most complete Python packages when it comes to financial data extraction in order to stop relying
16+
on public/private APIs, since investpy is **FREE** and has **NO LIMITATIONS**. These are some of the features that currently
17+
lead investpy to be one of the most consistent packages when it comes to financial data retrieval.
1218

1319
[![Python Version](https://img.shields.io/pypi/pyversions/investpy.svg)](https://pypi.org/project/investpy/)
1420
[![PyPI Version](https://img.shields.io/pypi/v/investpy.svg)](https://pypi.org/project/investpy/)
1521
[![Package Status](https://img.shields.io/pypi/status/investpy.svg)](https://pypi.org/project/investpy/)
1622
[![Build Status](https://github.com/alvarobartt/investpy/workflows/run_tests/badge.svg)](https://github.com/alvarobartt/investpy/actions?query=workflow%3Arun_tests)
1723
[![Documentation Status](https://readthedocs.org/projects/investpy/badge/?version=latest)](https://investpy.readthedocs.io/)
18-
[![codecov](https://codecov.io/gh/alvarobartt/investpy/branch/master/graph/badge.svg)](https://codecov.io/gh/alvarobartt/investpy)
24+
[![Code Coverage](https://codecov.io/gh/alvarobartt/investpy/branch/master/graph/badge.svg)](https://codecov.io/gh/alvarobartt/investpy)
1925

2026
**If you want to support the project, you can buy the developer a coffee. More information at: [buy-me-a-coffee](https://github.com/alvarobartt/buy-me-a-coffee)**
2127

@@ -27,25 +33,32 @@ In order to get this package working you will need to **install it via pip** (wi
2733

2834
``$ pip install investpy``
2935

30-
Additionally, **if you want to use the latest investpy version instead of the stable one**, you can just use the following command:
36+
Additionally, **if you want to use the latest investpy version instead of the stable one, you can install it from source** with the following command:
3137

32-
``$ pip install git+https://github.com/alvarobartt/investpy.git@developer``
38+
``$ pip install git+https://github.com/alvarobartt/investpy.git@master``
3339

34-
**The developer branch ensures the user that the most updated version will always be working and fully operative** so as not to wait until the stable release on the master branch comes out (which eventually may take some time depending on the amount of issues to solve).
40+
**The master branch ensures the user that the most updated version will always be working and fully operative** so as not to wait until the
41+
stable release on the master branch comes out (which eventually may take some time depending on the amount of issues to solve).
3542

3643
## Documentation
3744

3845
You can find the **complete investpy documentation** at [Documentation](https://investpy.readthedocs.io/).
3946

40-
__Notes__: documentation is hosted on [Read the Docs](https://readthedocs.org/) and generated using [sphinx](https://www.sphinx-doc.org/en/master/) with the theme [sphinx_rtd_theme](https://github.com/readthedocs/sphinx_rtd_theme) which is the standard Read the Docs theme for sphinx.
47+
__Notes__: documentation is hosted on [Read the Docs](https://readthedocs.org/) and generated using [sphinx](https://www.sphinx-doc.org/en/master/)
48+
with the theme [sphinx_rtd_theme](https://github.com/readthedocs/sphinx_rtd_theme) which is the standard Read the Docs theme for sphinx.
4149

4250
## Usage
4351

44-
Even though some investpy usage examples are presented on the [docs](https://investpy.readthedocs.io/usage.html), some basic functionality will be sorted out with sample Python code blocks. Additionally, more usage examples can be found under [examples/](https://github.com/alvarobartt/investpy/tree/master/examples) directory, which contains a collection of Jupyter Notebooks on how to use investpy and handle its data.
52+
Even though some investpy usage examples are presented on the [docs](https://investpy.readthedocs.io/usage.html), some basic
53+
functionality will be sorted out with sample Python code blocks. Additionally, more usage examples can be found under
54+
[examples/](https://github.com/alvarobartt/investpy/tree/master/examples) directory, which contains a collection of Jupyter
55+
Notebooks on how to use investpy and handle its data.
4556

4657
### Recent/Historical Data Retrieval
4758

48-
investpy allows the user to **download both recent and historical data from any financial product indexed** (stocks, funds, etfs, currency crosses, certificates, bonds, commodities indices and cryptos). In the example presented below, the historical data from the past years of an stock is retrieved.
59+
investpy allows the user to **download both recent and historical data from any financial product indexed** (stocks, funds,
60+
etfs, currency crosses, certificates, bonds, commodities indices and cryptos). In the example presented below, the historical
61+
data from the past years of an stock is retrieved.
4962

5063
```python
5164
import investpy
@@ -66,11 +79,15 @@ Date
6679
2010-01-08 30.04 30.29 29.87 30.28 111969192 USD
6780
```
6881

69-
So as to get to know all the available recent and historical data extraction functions provided by investpy, and also, parameter tuning, please read the docs.
82+
So as to get to know all the available recent and historical data extraction functions provided by investpy, and also,
83+
parameter tuning, please read the docs.
7084

7185
### Search Data
7286

73-
**Investing.com search engine is completely integrated** with investpy, which means that any available financial product (quote) can be easily found. The search function allows the user tune the parameters in order to adjust the search results to their needs, where both product types and countries from where the products are, can be specified. **All the search functionality can be easily used**, for example, as presented in the following piece of code:
87+
**Investing.com search engine is completely integrated** with investpy, which means that any available financial product
88+
(quote) can be easily found. The search function allows the user tune the parameters in order to adjust the search results
89+
to their needs, where both product types and countries from where the products are, can be specified. **All the search
90+
functionality can be easily used**, for example, as presented in the following piece of code:
7491

7592
```python
7693
import investpy
@@ -81,7 +98,11 @@ search_results = investpy.search_quotes(text='apple',
8198
n_results=10)
8299
```
83100

84-
Retrieved search results will be a `list` of `investpy.utils.search_obj.SearchObj` class instances. In order to get to know which are the available functions and attributes of the returned search results, please read the related documentation at [Search Engine Documentation](https://investpy.readthedocs.io/search_api.html). So on, those **search results let the user retrieve both recent and historical data from that concrete product, its information, etc.**, as presented in the piece of code below:
101+
Retrieved search results will be a `list` of `investpy.utils.search_obj.SearchObj` class instances. In order to get to
102+
know which are the available functions and attributes of the returned search results, please read the related documentation
103+
at [Search Engine Documentation](https://investpy.readthedocs.io/search_api.html). So on, those **search results let the
104+
user retrieve both recent and historical data from that concrete product, its information, etc.**, as presented in the
105+
piece of code below:
85106

86107
```python
87108
for search_result in search_results[:1]:
@@ -104,9 +125,13 @@ Date
104125

105126
### Crypto Currencies Data Retrieval
106127

107-
Crypto currencies support has recently been included, so as to let the user **retrieve data and information from any available crypto at Investing.com**. Please note that some crypto currencies do not have available data indexed at Investing.com so that it can not be retrieved using investpy neither, even though they are just a few, take it into consideration.
128+
Crypto currencies support has recently been included, so as to let the user **retrieve data and information from
129+
any available crypto at Investing.com**. Please note that some crypto currencies do not have available data indexed
130+
at Investing.com so that it can not be retrieved using investpy neither, even though they are just a few, take it
131+
into consideration.
108132

109-
As already presented previously, **historical data retrieval using investpy is really easy**. The piece of code presented below shows how to retrieve the past years of historical data from Bitcoin (BTC).
133+
As already presented previously, **historical data retrieval using investpy is really easy**. The piece of code
134+
presented below shows how to retrieve the past years of historical data from Bitcoin (BTC).
110135

111136
````python
112137
import investpy
@@ -127,16 +152,26 @@ Date
127152

128153
## Utilities
129154

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

132161
- [pyrtfolio](https://github.com/alvarobartt/pyrtfolio/): is a Python package to generate stock portfolios.
133162
- [trendet](https://github.com/alvarobartt/trendet/): is a Python package for trend detection on stock time series data.
134163

135-
**If you developed an interesting/useful project based on investpy data, please open an issue in order to let me know so as to include it on this section.**
164+
**If you developed an interesting/useful project based on investpy data, please open an issue in order to let me
165+
know so as to include it on this section.**
136166

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

139-
As this is an open source project it is **open to contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas**. There is an open tab of [issues](https://github.com/alvarobartt/investpy/issues) where anyone can open 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 problems**, this does not mean that issues can't be discussed, but so to keep a structured project management, the same issue should not describe different problems, just the main one and some nested/related errors that may be found.
169+
As this is an open source project it is **open to contributions, bug reports, bug fixes, documentation improvements,
170+
enhancements and ideas**. There is an open tab of [issues](https://github.com/alvarobartt/investpy/issues) where
171+
anyone can open new issues if needed or navigate through them in order to solve them or contribute to its solving.
172+
Remember that **issues are not threads to describe multiple problems**, this does not mean that issues can't be
173+
discussed, but so to keep a structured project management, the same issue should not describe different problems,
174+
just the main one and some nested/related errors that may be found.
140175

141176
## Citation
142177

@@ -155,6 +190,10 @@ When citing this repository on your publications please use the following **BibT
155190

156191
## Disclaimer
157192

158-
This Python package has been **made for research purposes** in order to fit the needs that Investing.com does not cover, so this package works like an Application Programming Interface (API) of Investing.com **developed in an altruistic way.**
193+
This Python package has been **made for research purposes** in order to fit the needs that Investing.com does
194+
not cover, so this package works like an Application Programming Interface (API) of Investing.com **developed
195+
in an altruistic way.**
159196

160-
Conclude that this package is not related in any way with Investing.com or any dependant company, the only requirement specified by Investing.com in order to develop this package was "*mention the source where data is retrieved from*".
197+
Conclude that this package is not related in any way with Investing.com or any dependant company, the only
198+
requirement specified by Investing.com in order to develop this package was "*mention the source where data
199+
is retrieved from*".

0 commit comments

Comments
 (0)