Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kevgathuku/top40

Simple command line that displays the songs in the current UK Top 40 charts
https://github.com/kevgathuku/top40

Last synced: about 1 month ago
JSON representation

Simple command line that displays the songs in the current UK Top 40 charts

Awesome Lists containing this project

README

        

Top 40
======

A simple command line program that displays songs in the current UK Top
40 Charts This also displays their YouTube links for convenience.

Install
-------

``pip install top40``

Setup
-----

| If you just need to display the songs without the YouTube links, no
additional action is required.
| You can skip ahead to the Usage section.

If you require to view the songs and their YouTube links:

Obtain a developer key from `Google`_ This is required for accessing the
YouTube API.

| Set the developer key as an environment variable:
| ``export DEVELOPER_KEY="Your developer key"``

Usage
-----

There is just one basic command to display the songs:

``top40 display [OPTIONS]``

Displaying Songs
~~~~~~~~~~~~~~~~

Example usage:

::

`top40 display` No arguments given. Displays the top 10 songs in the Charts.
`top40 display -n 30` This displays the top 30 songs in the chart
`top40 display -n 30 --links` This displays the top 30 songs in the chart and their YouTube links

OPTIONS
^^^^^^^

::

-h, --help print this help text and exit
-n, --num Specify the number of songs to display. Maximum of 40

Help
----

``top40 --help``

.. _Google: https://developers.google.com/youtube/registering_an_application