Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A Python3-only library for iChart K-Pop chart scores.

Project description

instiz

A Python3-only library for iChart K-Pop chart scores.

Code style: 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.

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.

from instiz.models import Entry

def get_name(entry: Entry) -> str:
    return entry.title

Artist name

It's now possible to get the Korean name and the English name of an artist easily, alongside with the raw artist name provided from iChart's site. Nice title property will always return the English name, unless unavailable. If one of the names are unavailable, the property will return an empty string.

from instiz import iChart

ichart = iChart()
first_place = ichart.get_next_entry()
nice_title = first_place.nice_title # JENNIE - SOLO
raw_artist_name = first_place.artist.raw_name # 제니 (JENNIE)
english_artist_name = first_place.artist.english_name # JENNIE
korean_artist_name = first_place.artist.korean_name # 제니

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for instiz, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size instiz-0.2.1-py3-none-any.whl (7.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size instiz-0.2.1.tar.gz (4.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page