Metadata-Version: 2.1
Name: renko
Version: 0.0.6
Summary: Renko chart creator.
Home-page: https://github.com/aticio/renko
Author: Özgür Atıcı
Author-email: aticiozgur@gmail.com
License: UNKNOWN
Description: # Renko
        
        Renko chart creator.
        
        ## Example Usage
        ```python
        from renko import Renko
        
        ...
        
            # Create new renko instance. Give brick size and list of close prices as parameters
            rnk = Renko(1000, close)
            rnk.create_renko()
        
            print(rnk.bricks)
        ...
        
        # The output will be like:
        [
        	{'type': 'first', 'open': 53041.32, 'close': 53041.32},
        	{'type': 'down', 'open': 53041.32, 'close': 52041.32},
        	{'type': 'down', 'open': 52041.32, 'close': 51041.32}, 
        	{'type': 'down', 'open': 51041.32, 'close': 50041.32}, 
        	{'type': 'down', 'open': 50041.32, 'close': 49041.32}, 
        	{'type': 'down', 'open': 49041.32, 'close': 48041.32}, 
        	{'type': 'down', 'open': 48041.32, 'close': 47041.32}, 
        	{'type': 'up', 'open': 48041.32, 'close': 49041.32}, 
        	{'type': 'up', 'open': 49041.32, 'close': 50041.32}, 
        	{'type': 'up', 'open': 50041.32, 'close': 51041.32}, 
        	{'type': 'down', 'open': 50041.32, 'close': 49041.32}, 
        	{'type': 'down', 'open': 49041.32, 'close': 48041.32},
        	{'type': 'up', 'open': 49041.32, 'close': 50041.32}, 
        	{'type': 'down', 'open': 49041.32, 'close': 48041.32}, 
        	{'type': 'down', 'open': 48041.32, 'close': 47041.32}, 
        	{'type': 'up', 'open': 48041.32, 'close': 49041.32}, 
        	{'type': 'down', 'open': 48041.32, 'close': 47041.32}, 
        	{'type': 'down', 'open': 47041.32, 'close': 46041.32}, 
        	{'type': 'up', 'open': 47041.32, 'close': 48041.32}, 
        	{'type': 'up', 'open': 48041.32, 'close': 49041.32}, 
        	{'type': 'up', 'open': 49041.32, 'close': 50041.32}, 
        	{'type': 'up', 'open': 50041.32, 'close': 51041.32}
        ]
        ```
        
        ```python
        from renko import Renko
        
        ...
        
            # If you use it live in your strategies, pass the current price to check_new_price() function. 
            # If new price change is big enough to create a new birck or bricks, 
            # the bricks list will be updated accordingly.
            rnk = Renko(1000, close)
            rnk.create_renko()
        
            print(rnk.bricks)
        
        ...
        
            rnk.check_new_price(100000)
        
            print("Bricks after new price added-------------")
            print(rnk.bricks)
        
        ```
        
        ## Installation
        
        Run the following to install:
        
        ```python
        pip install renko
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev
