PyFyGentleScrap 0.2.22

Unofficial Yahoo finance scrapper

PyFyGentleScrap: gently scrap financial data

DISCLAIMER: When using PyFyGentleScrap, you implicitely accept cookies and third party policies of the scrapped websites.

What is it?

PyFyGentleScrap is a python module to scrap financial data. It's goal is to fetch financial data from websites and return them as pandas data.

Gentle scrapping means that all web requests are designed to avoid the servers to detect the requests as scraping. This also means that cookies and licenses are accepted.

Main features

Yahoo scrapping (https://finance.yahoo.com)

Two functions are available to scrap yahoo :

• yahoo_equity_screener(regions=['Belgium', 'United States']), which will basically return EOD values (open/high/low/close/volume) + many additionnal informations.
• yahoo_historical_data(equities=['AAPL'])

_ https://finance.yahoo.com/screener/

Main dependencies

• Firefox
• Geckodriver
• Selenium
• Requests
• Pandas

Guide to contribute to the code

All contributions are welcome. If you think you've discovered an issue, please read this stackoverflow article for tips on writing a good bug report.

1. Forking

git clone https://gitlab.com/your-user-name/pyfygentlescrap.git
cd pyfygentlescrap
git remote add upstream https://gitlab.com/your-user-name/pyfygentlescrap

2. Set a virtual environment
3. Install main and development dependencies:

pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt

Note: Use the --upgrade option to update package to the last stable version.

4. (optionnal) Run tests to check that everything is working fine:

pytest

5. Create a new branch, test it, check linting, pull it:

git branch my_super_branch
git checkout my_super_branch

Code a super functionnality, then test it:

# linting:
black pyfygentlescrap
flake8 pyfygentlescrap
# building documention:
cd docs && make html
# testing, coverage:
python3 -m pytest # or simply `pytest`
python3 -m coverage run --source=. -m pytest && python3 -m coverage report -m