Metadata-Version: 2.1
Name: instiz
Version: 0.1.0
Summary: A Python3-only library for iChart K-Pop chart scores.
Home-page: https://github.com/Chromadream/instiz
Author: Jonathan Nicholas
Author-email: Jonathan.Nicholas@protonmail.com
License: UNKNOWN
Description: # instiz
        
        A Python3-only library for iChart K-Pop chart scores.
        
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
        
        ## Installation
        
        `pip install instiz`
        
        ## Getting Started
        
        Getting started is easy. The following example is to get the top 10 at the realtime chart of iChart.
        
        ```python
        from instiz import iChart
        
        ichart = iChart()
        top_10 = ichart.realtime_top_10()
        ```
        
        ## Type hinting
        
        If you're using Python 3.7+'s type hinting feature, the type used for the return type of the chart can be imported from the `instiz.models` module.
        
        ```python
        from instiz.models import Entry
        
        def get_name(entry: Entry) -> str:
            return entry.title
        
        ```
        
        ## Contributing
        
        * Fork the repo
        * Make your changes
        * Write your tests so I don't accidentally remove it when updating
        * Run the tests.
        * Make a pull request.
        
        ## TODO
        
        [] Document the API
        [] Weekly chart
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
