Metadata-Version: 2.1
Name: marketools
Version: 0.1.1
Summary: Tools for stock market analysis.
Home-page: https://github.com/AlbertRtk/marketools
Author: Albert Ratajczak
Author-email: ratajczakalbert@gmail.com
License: UNKNOWN
Description: marketools: tools for stock market analysis
        ===========================================
        
        [![PyPI Latest Release](https://img.shields.io/pypi/v/marketools.svg)](https://pypi.org/project/marketools/)
        [![License](https://img.shields.io/pypi/l/marketools.svg)](https://github.com/AlbertRtk/marketools/blob/main/LICENSE)
        [![Python Versions](https://img.shields.io/pypi/pyversions/marketools.svg)]()
        
        ## About
        marketools is a Python package for web scraping and analysis of stock market data. Project is under development. At the moment, analysis functionality is limited. You are welcomed to contribute to the project.
        
        ### Source of data
        Data are scraped from [Stooq](http://stooq.com/) service.
        
        ## Support
        You may report issues and functionality requests [here](https://github.com/AlbertRtk/marketools/issues).
        
        ## Installation
        ```bash
        pip install marketools
        ```
        or 
        ```bash
        git clone https://github.com/AlbertRtk/marketools.git
        ```
        
        ## Example
        Import Stock class
        ```python
        from marketools import Stock
        ```
        Create Stock instance for selected ticker, here [PKN](https://stooq.com/q/?s=pkn)
        ```python
        pkn = Stock('PKN')
        ```
        Get and print OHLC (open-high-low-close) data from the last 5 days
        ```python
        pkn_ohlc = pkn.ohlc  # returns pandas.DataFrame
        print(pkn.ohlc.tail(5))
        ```
        Print available fundamental information
        ```python
        print(pkn.fundamentals)
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
