Metadata-Version: 2.1
Name: pyfxgit
Version: 0.0.1
Summary: This is a package of helper classes and libraries.
Home-page: UNKNOWN
Author: Dennis Lee
Author-email: dennislwm@gmail.com
License: MIT
Description: # pyfxgit
        
        This is a package of helper classes and libraries.
        
        ## Author
        
        [dennislwm](https://github.com/dennislwm/pyfxgit)
        
        ## Installation
        
        ```
        $ pip install pyfxgit
        ```
        
        ## Example
        
        ```python
        from pyfxgit.ChartCls import ChartCls
        ```
        
        ## Getting Data
        
        Note: Variable **data** is of type DataFrame that consists of columns ['Open', 'High', 'Low', 'Close', 'Dbs', 'DbsMa'].
        
        ### Add indicator charts
        
        ```python
        chart = ChartCls(data, intSub=2)
        chart.BuildOscillator(1, data['Dbs'], intUpper=3, intLower=-3, strTitle="Dbs")
        chart.BuildOscillator(0, data['DbsMa'], intUpper=3.75, intLower=-3.75, strTitle="DbsMa")
        ```
        
        ### Build tags  
        
        ```python
        lstTag = chart.BuildOscillatorTag(data, 'DbsMa', 3.75)
        ```
        
        ### Add spans to main chart
        
        ```python
        chart.MainAddSpan(data['Tag'], lstTag[lstTag>0], 0.2, 'red')
        chart.MainAddSpan(data['Tag'], lstTag[lstTag<0], 0.2, 'green')
        ```
        
        ### Build main chart
        
        ```python
        chart.BuildMain(strTitle="SPY")
        ```
        
        ### Save chart
        
        ```python
        chart.save("Dbs")
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
